├── README.txt
├── db
├── upgrade.php
├── access.php
└── services.php
├── version.php
├── lang
├── en
│ └── gradereport_planstate.php
└── es
│ └── gradereport_planstate.php
├── classes
├── privacy
│ └── provider.php
├── event
│ └── grade_report_viewed.php
└── external.php
├── renderer.php
├── settings.php
├── index.php
├── tests
└── externallib_test.php
├── lib.php
└── LICENSE
/README.txt:
--------------------------------------------------------------------------------
1 | Grade report Plan state
2 | ============================
3 | A custom grade report to show categories and completion info.
4 |
5 | Package tested in: moodle 3.7+
6 |
7 | QUICK INSTALL
8 | ==============
9 | Download zip package, extract the planstate folder and upload this folder into grade/report/.
10 |
11 | ABOUT
12 | =============
13 | Developed by: David Herney - davidherney at gmail dot com
14 | GIT: https://github.com/davidherney/moodle-gradereport_planstate
15 | Powered by: https://bambuco.co/
16 |
17 | IN VERSION
18 | =============
19 | 2021091300:
20 | Start project.
--------------------------------------------------------------------------------
/db/upgrade.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Grade planstate report upgrade steps.
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | defined('MOODLE_INTERNAL') || die();
26 |
27 | /**
28 | * Function to upgrade grade planstate report.
29 | *
30 | * @param int $oldversion the version we are upgrading from
31 | * @return bool result
32 | */
33 | function xmldb_gradereport_planstate_upgrade($oldversion) {
34 |
35 | return true;
36 | }
37 |
--------------------------------------------------------------------------------
/version.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Version details for the planstate gradebook report
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | defined('MOODLE_INTERNAL') || die();
26 |
27 | $plugin->version = 2021091301.01; // The current plugin version (Date: YYYYMMDDXX)
28 | $plugin->requires = 2019051100; // Requires this Moodle version
29 | $plugin->component = 'gradereport_planstate'; // Full name of the plugin (used for diagnostics)
30 |
--------------------------------------------------------------------------------
/db/access.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Defines capabilities for the planstate report
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | defined('MOODLE_INTERNAL') || die();
26 |
27 | $capabilities = array(
28 |
29 | 'gradereport/planstate:view' => array(
30 | 'riskbitmask' => RISK_PERSONAL,
31 | 'captype' => 'read',
32 | 'contextlevel' => CONTEXT_COURSE,
33 | 'archetypes' => array(
34 | 'user' => CAP_ALLOW
35 | )
36 | )
37 |
38 | );
39 |
40 |
41 |
--------------------------------------------------------------------------------
/lang/en/gradereport_planstate.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Strings for component 'gradereport_planstate', language 'en'
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | $string['eventgradereportviewed'] = 'Grade plan state report viewed';
26 | $string['gradesplanstate'] = 'Plan state';
27 | $string['pluginname'] = 'Plan state report';
28 | $string['privacy:metadata'] = 'The Grade plan state report only shows data stored in other locations.';
29 | $string['planstate:view'] = 'View the plan state report';
30 | $string['idcategories'] = 'Id categories';
31 | $string['idcategories_help'] = 'Only show categories with these ids. For example:
32 | 1, 2, 3';
33 |
--------------------------------------------------------------------------------
/lang/es/gradereport_planstate.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Strings for component 'gradereport_planstate', language 'es'
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | $string['eventgradereportviewed'] = 'Estado del plan de calificación visualizado';
26 | $string['gradesplanstate'] = 'Estado del plan de estudio';
27 | $string['pluginname'] = 'Plan de estudio';
28 | $string['privacy:metadata'] = 'El reporte del plan de estudio solamente muestra información ya almacenada en el sistema.';
29 | $string['planstate:view'] = 'Ver el reporte de estado del plan de estudios';
30 | $string['idcategories'] = 'Id de categorías';
31 | $string['idcategories_help'] = 'Solamente mostrar las categorías con los siguientes id. Indique los id separados por coma, por ejemplo:
32 | 1, 2, 3';
33 |
--------------------------------------------------------------------------------
/classes/privacy/provider.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Privacy Subsystem implementation for gradereport_planstate.
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | namespace gradereport_planstate\privacy;
26 |
27 | defined('MOODLE_INTERNAL') || die();
28 |
29 | /**
30 | * Privacy Subsystem for gradereport_planstate implementing null_provider.
31 | *
32 | * @copyright 2021 David Herney - cirano
33 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 | */
35 | class provider implements \core_privacy\local\metadata\null_provider {
36 |
37 | /**
38 | * Get the language string identifier with the component's language
39 | * file to explain why this plugin stores no data.
40 | *
41 | * @return string
42 | */
43 | public static function get_reason() : string {
44 | return 'privacy:metadata';
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/db/services.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Plan state grade report external functions and service definitions.
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | defined('MOODLE_INTERNAL') || die();
26 |
27 | $functions = array(
28 |
29 | 'gradereport_planstate_get_course_grades' => array(
30 | 'classname' => 'gradereport_planstate_external',
31 | 'methodname' => 'get_course_grades',
32 | 'description' => 'Get the given user courses final grades',
33 | 'type' => 'read',
34 | 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
35 | ),
36 | 'gradereport_planstate_view_grade_report' => array(
37 | 'classname' => 'gradereport_planstate_external',
38 | 'methodname' => 'view_grade_report',
39 | 'description' => 'Trigger the report view event',
40 | 'type' => 'write',
41 | 'capabilities' => 'gradereport/planstate:view',
42 | 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
43 | )
44 | );
45 |
--------------------------------------------------------------------------------
/renderer.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Renderer for the gradebook planstate report
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | /**
26 | * Custom renderer for the user grade report
27 | *
28 | * To get an instance of this use the following code:
29 | * $renderer = $PAGE->get_renderer('gradereport_planstate');
30 | *
31 | * @copyright 2021 David Herney - cirano
32 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33 | */
34 | class gradereport_planstate_renderer extends plugin_renderer_base {
35 |
36 | public function graded_users_selector($report, $course, $userid, $groupid, $includeall) {
37 | global $USER;
38 |
39 | $select = grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall);
40 | $output = html_writer::tag('div', $this->output->render($select), array('id'=>'graded_users_selector'));
41 | $output .= html_writer::tag('p', '', array('style'=>'page-break-after: always;'));
42 |
43 | return $output;
44 | }
45 |
46 | }
47 |
--------------------------------------------------------------------------------
/classes/event/grade_report_viewed.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Plan state report viewed event.
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | namespace gradereport_planstate\event;
26 |
27 | defined('MOODLE_INTERNAL') || die();
28 |
29 | /**
30 | * Plan state report viewed event class.
31 | *
32 | * @package gradereport_planstate
33 | * @since Moodle 2.8
34 | * @copyright 2021 David Herney - cirano
35 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 | */
37 | class grade_report_viewed extends \core\event\grade_report_viewed {
38 |
39 | /**
40 | * Initialise the event data.
41 | * @return void
42 | */
43 | protected function init() {
44 | parent::init();
45 | $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
46 | }
47 |
48 | /**
49 | * Returns localised general event name.
50 | *
51 | * @return string
52 | */
53 | public static function get_name() {
54 | return get_string('eventgradereportviewed', 'gradereport_planstate');
55 | }
56 |
57 | /**
58 | * Custom validation.
59 | *
60 | * Throw \coding_exception notice in case of any problems.
61 | */
62 | protected function validate_data() {
63 | parent::validate_data();
64 |
65 | if (!isset($this->relateduserid)) {
66 | throw new \coding_exception('The \'relateduserid\' value must be set.');
67 | }
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/settings.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Defines site settings for the planstate gradebook report
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | defined('MOODLE_INTERNAL') || die;
26 |
27 | if ($ADMIN->fulltree) {
28 |
29 | $settings->add(new admin_setting_configcheckbox('grade_report_planstate_showrank', get_string('showrank', 'grades'),
30 | get_string('showrank_help', 'grades'), 0));
31 |
32 | $settings->add(new admin_setting_configselect('grade_report_planstate_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'),
33 | get_string('hidetotalifhiddenitems_help', 'grades'), GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN,
34 | array(GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'),
35 | GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'),
36 | GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') )));
37 |
38 |
39 | // Visible categories.
40 | $name = 'grade_report_planstate_idcategories';
41 | $title = get_string('idcategories', 'gradereport_planstate');
42 | $help = get_string('idcategories_help', 'gradereport_planstate');
43 | $setting = new admin_setting_configtextarea($name, $title, $help, '');
44 | $settings->add($setting);
45 |
46 | }
47 |
--------------------------------------------------------------------------------
/index.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * The gradebook planstate report
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | require_once '../../../config.php';
26 | require_once $CFG->libdir.'/gradelib.php';
27 | require_once $CFG->dirroot.'/grade/lib.php';
28 | require_once $CFG->dirroot.'/grade/report/planstate/lib.php';
29 |
30 | $courseid = optional_param('id', SITEID, PARAM_INT);
31 | $userid = optional_param('userid', $USER->id, PARAM_INT);
32 |
33 | $PAGE->set_url(new moodle_url('/grade/report/planstate/index.php', array('id' => $courseid, 'userid' => $userid)));
34 |
35 | if (!$course = $DB->get_record('course', array('id' => $courseid))) {
36 | print_error('invalidcourseid');
37 | }
38 | require_login(null, false);
39 | $PAGE->set_course($course);
40 |
41 | $context = context_course::instance($course->id);
42 | $systemcontext = context_system::instance();
43 | $personalcontext = null;
44 |
45 | // If we are accessing the page from a site context then ignore this check.
46 | if ($courseid != SITEID) {
47 | require_capability('gradereport/planstate:view', $context);
48 | }
49 |
50 | if (empty($userid)) {
51 | require_capability('moodle/grade:viewall', $context);
52 |
53 | } else {
54 | if (!$DB->get_record('user', array('id'=>$userid, 'deleted'=>0)) or isguestuser($userid)) {
55 | print_error('invaliduserid');
56 | }
57 | $personalcontext = context_user::instance($userid);
58 | }
59 |
60 | if (isset($personalcontext) && $courseid == SITEID) {
61 | $PAGE->set_context($personalcontext);
62 | } else {
63 | $PAGE->set_context($context);
64 | }
65 | if ($userid == $USER->id) {
66 | $settings = $PAGE->settingsnav->find('mygrades', null);
67 | $settings->make_active();
68 | } else if ($courseid != SITEID && $userid) {
69 | // Show some other navbar thing.
70 | $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
71 | $PAGE->navigation->extend_for_user($user);
72 | }
73 |
74 | $access = grade_report_planstate::check_access($systemcontext, $context, $personalcontext, $course, $userid);
75 |
76 | if (!$access) {
77 | // no access to grades!
78 | print_error('nopermissiontoviewgrades', 'error', $CFG->wwwroot.'/course/view.php?id='.$courseid);
79 | }
80 |
81 | /// return tracking object
82 | $gpr = new grade_plugin_return(array('type'=>'report', 'plugin'=>'planstate', 'courseid'=>$course->id, 'userid'=>$userid));
83 |
84 | /// last selected report session tracking
85 | if (!isset($USER->grade_last_report)) {
86 | $USER->grade_last_report = array();
87 | }
88 | $USER->grade_last_report[$course->id] = 'planstate';
89 |
90 | // First make sure we have proper final grades.
91 | grade_regrade_final_grades_if_required($course);
92 |
93 |
94 | $categories = $DB->get_records('course_categories', array('visible' => 1), 'sortorder ASC');
95 | $hascourses = false;
96 |
97 | $idcategories = explode(',', $CFG->grade_report_planstate_idcategories);
98 |
99 | $availablecategories = array();
100 | foreach ($idcategories as $oneid) {
101 | $oneid = trim($oneid);
102 | if (!empty($oneid)) {
103 | $availablecategories[] = (int)$oneid;
104 | }
105 | }
106 |
107 | if (count($availablecategories) == 0) {
108 | $availablecategories = null;
109 | }
110 |
111 | foreach ($categories as $category) {
112 |
113 | if ($availablecategories && !in_array($category->id, $availablecategories)) {
114 | continue;
115 | }
116 |
117 | // Create a report instance
118 | $report = new grade_report_planstate($userid, $gpr, $context, $category->id);
119 |
120 | if (!empty($report->studentcourseids)) {
121 |
122 | if (!$hascourses) {
123 | if ($courseid == SITEID) {
124 | $PAGE->set_pagelayout('standard');
125 | $header = get_string('grades', 'grades') . ' - ' . fullname($report->user);
126 | $PAGE->set_title($header);
127 | $PAGE->set_heading(fullname($report->user));
128 | echo $OUTPUT->header();
129 | echo html_writer::tag('h3', get_string('coursesiamtaking', 'grades'));
130 | } else {
131 | print_grade_page_head($courseid, 'report', 'planstate', get_string('pluginname', 'gradereport_planstate')
132 | . ' - ' . fullname($report->user));
133 | }
134 | $hascourses = true;
135 | }
136 |
137 | echo html_writer::empty_tag('hr');
138 | echo html_writer::tag('h4', $category->name);
139 |
140 | // If the course id matches the site id then we don't have a course context to work with.
141 | // Display a standard page.
142 | if ($courseid == SITEID) {
143 | if ($USER->id != $report->user->id) {
144 | $PAGE->navigation->extend_for_user($report->user);
145 | if ($node = $PAGE->settingsnav->get('userviewingsettings'.$report->user->id)) {
146 | $node->forceopen = true;
147 | }
148 | } else if ($node = $PAGE->settingsnav->get('usercurrentsettings', navigation_node::TYPE_CONTAINER)) {
149 | $node->forceopen = true;
150 | }
151 | }
152 |
153 | if ($report->fill_table(false, true)) {
154 | echo $report->print_table(true);
155 | }
156 |
157 | }
158 | }
159 |
160 | if (!$hascourses) {
161 | $PAGE->set_pagelayout('standard');
162 | $header = get_string('grades', 'grades') . ' - ' . fullname($report->user);
163 | $PAGE->set_title($header);
164 | $PAGE->set_heading(fullname($report->user));
165 | echo $OUTPUT->header();
166 | // We have no report to show the user. Let them know something.
167 | echo $OUTPUT->notification(get_string('noreports', 'grades'), 'notifymessage');
168 | }
169 |
170 |
171 | grade_report_planstate::viewed($context, $courseid, $userid);
172 |
173 | echo $OUTPUT->footer();
174 |
--------------------------------------------------------------------------------
/classes/external.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * External grade report planstate API
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | defined('MOODLE_INTERNAL') || die;
26 |
27 | require_once($CFG->libdir . '/externallib.php');
28 | require_once($CFG->libdir . '/gradelib.php');
29 | require_once($CFG->dirroot . '/grade/lib.php');
30 | require_once($CFG->dirroot . '/grade/report/planstate/lib.php');
31 |
32 | /**
33 | * External grade planstate report API implementation
34 | *
35 | * @package gradereport_planstate
36 | * @copyright 2021 David Herney - cirano
37 | * @category external
38 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39 | */
40 | class gradereport_planstate_external extends external_api {
41 |
42 | /**
43 | * Describes the parameters for get_course_grades.
44 | *
45 | * @return external_function_parameters
46 | * @since Moodle 3.2
47 | */
48 | public static function get_course_grades_parameters() {
49 | return new external_function_parameters (
50 | array(
51 | 'userid' => new external_value(PARAM_INT, 'Get grades for this user (optional, default current)', VALUE_DEFAULT, 0)
52 | )
53 | );
54 | }
55 |
56 | /**
57 | * Get the given user courses final grades
58 | *
59 | * @param int $userid get grades for this user (optional, default current)
60 | *
61 | * @return array the grades tables
62 | * @since Moodle 3.2
63 | */
64 | public static function get_course_grades($userid = 0) {
65 | global $USER;
66 |
67 | $warnings = array();
68 |
69 | // Validate the parameter.
70 | $params = self::validate_parameters(self::get_course_grades_parameters(),
71 | array(
72 | 'userid' => $userid
73 | )
74 | );
75 |
76 | $userid = $params['userid'];
77 | if (empty($userid)) {
78 | $userid = $USER->id;
79 | }
80 |
81 | $systemcontext = context_system::instance();
82 | self::validate_context($systemcontext);
83 |
84 | if ($USER->id != $userid) {
85 | // We must check if the current user can view other users grades.
86 | $user = core_user::get_user($userid, '*', MUST_EXIST);
87 | core_user::require_active_user($user);
88 | require_capability('moodle/grade:viewall', $systemcontext);
89 | }
90 |
91 | // We need the site course, and course context.
92 | $course = get_course(SITEID);
93 | $context = context_course::instance($course->id);
94 |
95 | // Force a regrade if required.
96 | grade_regrade_final_grades_if_required($course);
97 | // Get the course final grades now.
98 | $gpr = new grade_plugin_return(array('type' => 'report', 'plugin' => 'planstate', 'courseid' => $course->id,
99 | 'userid' => $userid));
100 | $report = new grade_report_planstate($userid, $gpr, $context);
101 | $coursesgrades = $report->setup_courses_data(true);
102 |
103 | $grades = array();
104 | foreach ($coursesgrades as $coursegrade) {
105 | $gradeinfo = array(
106 | 'courseid' => $coursegrade['course']->id,
107 | 'grade' => grade_format_gradevalue($coursegrade['finalgrade'], $coursegrade['courseitem'], true),
108 | 'rawgrade' => $coursegrade['finalgrade'],
109 | );
110 | if (isset($coursegrade['rank'])) {
111 | $gradeinfo['rank'] = $coursegrade['rank'];
112 | }
113 | $grades[] = $gradeinfo;
114 | }
115 |
116 | $result = array();
117 | $result['grades'] = $grades;
118 | $result['warnings'] = $warnings;
119 | return $result;
120 | }
121 |
122 | /**
123 | * Describes the get_course_grades return value.
124 | *
125 | * @return external_single_structure
126 | * @since Moodle 3.2
127 | */
128 | public static function get_course_grades_returns() {
129 | return new external_single_structure(
130 | array(
131 | 'grades' => new external_multiple_structure(
132 | new external_single_structure(
133 | array(
134 | 'courseid' => new external_value(PARAM_INT, 'Course id'),
135 | 'grade' => new external_value(PARAM_RAW, 'Grade formatted'),
136 | 'rawgrade' => new external_value(PARAM_RAW, 'Raw grade, not formatted'),
137 | 'rank' => new external_value(PARAM_INT, 'Your rank in the course', VALUE_OPTIONAL),
138 | )
139 | )
140 | ),
141 | 'warnings' => new external_warnings()
142 | )
143 | );
144 | }
145 |
146 | /**
147 | * Returns description of method parameters
148 | *
149 | * @return external_function_parameters
150 | * @since Moodle 3.2
151 | */
152 | public static function view_grade_report_parameters() {
153 | return new external_function_parameters(
154 | array(
155 | 'courseid' => new external_value(PARAM_INT, 'id of the course'),
156 | 'userid' => new external_value(PARAM_INT, 'id of the user, 0 means current user', VALUE_DEFAULT, 0)
157 | )
158 | );
159 | }
160 |
161 | /**
162 | * Trigger the user report events, do the same that the web interface view of the report
163 | *
164 | * @param int $courseid id of course
165 | * @param int $userid id of the user the report belongs to
166 | * @return array of warnings and status result
167 | * @since Moodle 3.2
168 | * @throws moodle_exception
169 | */
170 | public static function view_grade_report($courseid, $userid = 0) {
171 | global $USER;
172 |
173 | $params = self::validate_parameters(self::view_grade_report_parameters(),
174 | array(
175 | 'courseid' => $courseid,
176 | 'userid' => $userid
177 | )
178 | );
179 |
180 | $warnings = array();
181 | $course = get_course($params['courseid']);
182 |
183 | $context = context_course::instance($course->id);
184 | self::validate_context($context);
185 |
186 | $userid = $params['userid'];
187 | if (empty($userid)) {
188 | $userid = $USER->id;
189 | } else {
190 | $user = core_user::get_user($userid, '*', MUST_EXIST);
191 | core_user::require_active_user($user);
192 | }
193 | $systemcontext = context_system::instance();
194 | $personalcontext = context_user::instance($userid);
195 |
196 | $access = grade_report_planstate::check_access($systemcontext, $context, $personalcontext, $course, $userid);
197 |
198 | if (!$access) {
199 | throw new moodle_exception('nopermissiontoviewgrades', 'error');
200 | }
201 |
202 | grade_report_planstate::viewed($context, $course->id, $userid);
203 |
204 | $result = array();
205 | $result['status'] = true;
206 | $result['warnings'] = $warnings;
207 | return $result;
208 | }
209 |
210 | /**
211 | * Returns description of method result value
212 | *
213 | * @return external_description
214 | * @since Moodle 3.2
215 | */
216 | public static function view_grade_report_returns() {
217 | return new external_single_structure(
218 | array(
219 | 'status' => new external_value(PARAM_BOOL, 'status: true if success'),
220 | 'warnings' => new external_warnings()
221 | )
222 | );
223 | }
224 | }
225 |
--------------------------------------------------------------------------------
/tests/externallib_test.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Plan state grade report functions unit tests
19 | *
20 | * @package gradereport_planstate
21 | * @category external
22 | * @copyright 2021 David Herney - cirano
23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 | */
25 |
26 | defined('MOODLE_INTERNAL') || die();
27 |
28 | global $CFG;
29 |
30 | require_once($CFG->dirroot . '/webservice/tests/helpers.php');
31 |
32 | /**
33 | * Plan state grade report functions unit tests
34 | *
35 | * @package gradereport_planstate
36 | * @category external
37 | * @copyright 2021 David Herney - cirano
38 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39 | */
40 | class gradereport_planstate_externallib_testcase extends externallib_advanced_testcase {
41 |
42 | /**
43 | * Set up for every test
44 | */
45 | public function setUp() {
46 | global $DB;
47 | $this->resetAfterTest(true);
48 |
49 | $s1grade1 = 80;
50 | $s1grade2 = 40;
51 | $s2grade = 60;
52 |
53 | $this->course1 = $this->getDataGenerator()->create_course();
54 | $this->course2 = $this->getDataGenerator()->create_course();
55 |
56 | $studentrole = $DB->get_record('role', array('shortname' => 'student'));
57 | $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
58 | $this->student1 = $this->getDataGenerator()->create_user();
59 | $this->teacher = $this->getDataGenerator()->create_user();
60 | $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course1->id, $teacherrole->id);
61 | $this->getDataGenerator()->enrol_user($this->student1->id, $this->course1->id, $studentrole->id);
62 | $this->getDataGenerator()->enrol_user($this->student1->id, $this->course2->id, $studentrole->id);
63 |
64 | $this->student2 = $this->getDataGenerator()->create_user();
65 | $this->getDataGenerator()->enrol_user($this->student2->id, $this->course1->id, $studentrole->id);
66 | $this->getDataGenerator()->enrol_user($this->student2->id, $this->course2->id, $studentrole->id);
67 |
68 | $assignment1 = $this->getDataGenerator()->create_module('assign', array('name' => "Test assign", 'course' => $this->course1->id));
69 | $assignment2 = $this->getDataGenerator()->create_module('assign', array('name' => "Test assign", 'course' => $this->course2->id));
70 | $modcontext1 = get_coursemodule_from_instance('assign', $assignment1->id, $this->course1->id);
71 | $modcontext2 = get_coursemodule_from_instance('assign', $assignment2->id, $this->course2->id);
72 | $assignment1->cmidnumber = $modcontext1->id;
73 | $assignment2->cmidnumber = $modcontext2->id;
74 |
75 | $this->student1grade1 = array('userid' => $this->student1->id, 'rawgrade' => $s1grade1);
76 | $this->student1grade2 = array('userid' => $this->student1->id, 'rawgrade' => $s1grade2);
77 | $this->student2grade = array('userid' => $this->student2->id, 'rawgrade' => $s2grade);
78 | $studentgrades = array($this->student1->id => $this->student1grade1, $this->student2->id => $this->student2grade);
79 | assign_grade_item_update($assignment1, $studentgrades);
80 | $studentgrades = array($this->student1->id => $this->student1grade2);
81 | assign_grade_item_update($assignment2, $studentgrades);
82 |
83 | grade_get_setting($this->course1->id, 'report_planstate_showrank', 1);
84 | }
85 |
86 | /**
87 | * Test get_course_grades function case student
88 | */
89 | public function test_get_course_grades_student() {
90 |
91 | // A user can see his own grades in both courses.
92 | $this->setUser($this->student1);
93 | $studentgrades = gradereport_planstate_external::get_course_grades();
94 | $studentgrades = external_api::clean_returnvalue(gradereport_planstate_external::get_course_grades_returns(), $studentgrades);
95 |
96 | $this->assertCount(0, $studentgrades['warnings']);
97 | $this->assertCount(2, $studentgrades['grades']);
98 | foreach ($studentgrades['grades'] as $grade) {
99 | if ($grade['courseid'] == $this->course1->id) {
100 | $this->assertEquals(80.00, $grade['grade']);
101 | $this->assertEquals(80.0000, $grade['rawgrade']);
102 | $this->assertEquals(1, $grade['rank']);
103 | } else {
104 | $this->assertEquals(40.00, $grade['grade']);
105 | $this->assertEquals(40.0000, $grade['rawgrade']);
106 | $this->assertArrayNotHasKey('rank', $grade);
107 | }
108 | }
109 |
110 | // Second student, no grade in one course.
111 | $this->setUser($this->student2);
112 | $studentgrades = gradereport_planstate_external::get_course_grades();
113 | $studentgrades = external_api::clean_returnvalue(gradereport_planstate_external::get_course_grades_returns(), $studentgrades);
114 |
115 | $this->assertCount(0, $studentgrades['warnings']);
116 | $this->assertCount(2, $studentgrades['grades']);
117 | foreach ($studentgrades['grades'] as $grade) {
118 | if ($grade['courseid'] == $this->course1->id) {
119 | $this->assertEquals(60.00, $grade['grade']);
120 | $this->assertEquals(60.0000, $grade['rawgrade']);
121 | $this->assertEquals(2, $grade['rank']);
122 | } else {
123 | $this->assertEquals('-', $grade['grade']);
124 | $this->assertEmpty($grade['rawgrade']);
125 | $this->assertArrayNotHasKey('rank', $grade);
126 | }
127 | }
128 | }
129 |
130 | /**
131 | * Test get_course_grades function case admin
132 | */
133 | public function test_get_course_grades_admin() {
134 |
135 | // A admin must see all student grades.
136 | $this->setAdminUser();
137 |
138 | $studentgrades = gradereport_planstate_external::get_course_grades($this->student1->id);
139 | $studentgrades = external_api::clean_returnvalue(gradereport_planstate_external::get_course_grades_returns(), $studentgrades);
140 | $this->assertCount(0, $studentgrades['warnings']);
141 | $this->assertCount(2, $studentgrades['grades']);
142 | foreach ($studentgrades['grades'] as $grade) {
143 | if ($grade['courseid'] == $this->course1->id) {
144 | $this->assertEquals(80.00, $grade['grade']);
145 | $this->assertEquals(80.0000, $grade['rawgrade']);
146 | } else {
147 | $this->assertEquals(40.00, $grade['grade']);
148 | $this->assertEquals(40.0000, $grade['rawgrade']);
149 | }
150 | }
151 |
152 | $studentgrades = gradereport_planstate_external::get_course_grades($this->student2->id);
153 | $studentgrades = external_api::clean_returnvalue(gradereport_planstate_external::get_course_grades_returns(), $studentgrades);
154 | $this->assertCount(0, $studentgrades['warnings']);
155 | $this->assertCount(2, $studentgrades['grades']);
156 |
157 | // Admins don't see grades.
158 | $studentgrades = gradereport_planstate_external::get_course_grades();
159 | $studentgrades = external_api::clean_returnvalue(gradereport_planstate_external::get_course_grades_returns(), $studentgrades);
160 | $this->assertCount(0, $studentgrades['warnings']);
161 | $this->assertCount(0, $studentgrades['grades']);
162 | }
163 |
164 | /**
165 | * Test get_course_grades function case teacher
166 | */
167 | public function test_get_course_grades_teacher() {
168 | // Teachers don't see grades.
169 | $this->setUser($this->teacher);
170 |
171 | $studentgrades = gradereport_planstate_external::get_course_grades();
172 | $studentgrades = external_api::clean_returnvalue(gradereport_planstate_external::get_course_grades_returns(), $studentgrades);
173 | $this->assertCount(0, $studentgrades['warnings']);
174 | $this->assertCount(0, $studentgrades['grades']);
175 | }
176 |
177 | /**
178 | * Test get_course_grades function case incorrect permissions
179 | */
180 | public function test_get_course_grades_permissions() {
181 | // Student can't see other student grades.
182 | $this->setUser($this->student2);
183 |
184 | $this->expectException('required_capability_exception');
185 | $studentgrade = gradereport_planstate_external::get_course_grades($this->student1->id);
186 | }
187 |
188 | /**
189 | * Test view_grade_report function
190 | */
191 | public function test_view_grade_report() {
192 | global $USER;
193 |
194 | // Redirect events to the sink, so we can recover them later.
195 | $sink = $this->redirectEvents();
196 |
197 | $this->setUser($this->student1);
198 | $result = gradereport_planstate_external::view_grade_report($this->course1->id);
199 | $result = external_api::clean_returnvalue(gradereport_planstate_external::view_grade_report_returns(), $result);
200 | $events = $sink->get_events();
201 | $this->assertCount(1, $events);
202 | $event = reset($events);
203 |
204 | // Check the event details are correct.
205 | $this->assertInstanceOf('\gradereport_planstate\event\grade_report_viewed', $event);
206 | $this->assertEquals(context_course::instance($this->course1->id), $event->get_context());
207 | $this->assertEquals($USER->id, $event->get_data()['relateduserid']);
208 |
209 | $this->setUser($this->teacher);
210 | $result = gradereport_planstate_external::view_grade_report($this->course1->id, $this->student1->id);
211 | $result = external_api::clean_returnvalue(gradereport_planstate_external::view_grade_report_returns(), $result);
212 | $events = $sink->get_events();
213 | $event = reset($events);
214 | $sink->close();
215 |
216 | // Check the event details are correct.
217 | $this->assertInstanceOf('\gradereport_planstate\event\grade_report_viewed', $event);
218 | $this->assertEquals(context_course::instance($this->course1->id), $event->get_context());
219 | $this->assertEquals($this->student1->id, $event->get_data()['relateduserid']);
220 | }
221 |
222 | /**
223 | * Test view_grade_report_permissions function
224 | */
225 | public function test_view_grade_report_permissions() {
226 | $this->setUser($this->student2);
227 |
228 | $this->expectException('moodle_exception');
229 | $studentgrade = gradereport_planstate_external::view_grade_report($this->course1->id, $this->student1->id);
230 | }
231 | }
232 |
--------------------------------------------------------------------------------
/lib.php:
--------------------------------------------------------------------------------
1 | .
16 |
17 | /**
18 | * Definition of the grade_planstate_report class
19 | *
20 | * @package gradereport_planstate
21 | * @copyright 2021 David Herney - cirano
22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 | */
24 |
25 | require_once($CFG->dirroot . '/grade/report/lib.php');
26 | require_once($CFG->libdir.'/tablelib.php');
27 |
28 | /**
29 | * Class providing an API for the planstate report building and displaying.
30 | * @uses grade_report
31 | * @package gradereport_planstate
32 | */
33 | class grade_report_planstate extends grade_report {
34 |
35 | /**
36 | * The user.
37 | * @var object $user
38 | */
39 | public $user;
40 |
41 | /**
42 | * The user's courses
43 | * @var array $courses
44 | */
45 | public $courses;
46 |
47 | /**
48 | * A flexitable to hold the data.
49 | * @var object $table
50 | */
51 | public $table;
52 |
53 | /**
54 | * Show student ranks within each course.
55 | * @var array $showrank
56 | */
57 | public $showrank;
58 |
59 | /**
60 | * show course/category totals if they contain hidden items
61 | */
62 | var $showtotalsifcontainhidden;
63 |
64 | /**
65 | * An array of course ids that the user is a student in.
66 | * @var array $studentcourseids
67 | */
68 | public $studentcourseids;
69 |
70 | /**
71 | * An array of courses that the user is a teacher in.
72 | * @var array $teachercourses
73 | */
74 | public $teachercourses;
75 |
76 | /**
77 | * Constructor. Sets local copies of user preferences and initialises grade_tree.
78 | * @param int $userid
79 | * @param object $gpr grade plugin return tracking object
80 | * @param string $context
81 | */
82 | public function __construct($userid, $gpr, $context, $categoryid) {
83 | global $CFG, $COURSE, $DB;
84 | parent::__construct($COURSE->id, $gpr, $context);
85 |
86 | // Get the user (for full name).
87 | $this->user = $DB->get_record('user', array('id' => $userid));
88 |
89 | // Load the user's courses.
90 | $this->courses = enrol_get_users_courses($this->user->id, false, 'id, shortname, showgrades, category, enablecompletion');
91 |
92 | $this->showrank = array();
93 | $this->showrank['any'] = false;
94 |
95 | $this->showtotalsifcontainhidden = array();
96 |
97 | $this->studentcourseids = array();
98 | $this->teachercourses = array();
99 | $roleids = explode(',', get_config('moodle', 'gradebookroles'));
100 |
101 | if ($this->courses) {
102 | foreach ($this->courses as $course) {
103 |
104 | if ($categoryid !== null && $course->category != $categoryid) {
105 | continue;
106 | }
107 |
108 | $this->showrank[$course->id] = grade_get_setting($course->id, 'report_planstate_showrank', !empty($CFG->grade_report_planstate_showrank));
109 | if ($this->showrank[$course->id]) {
110 | $this->showrank['any'] = true;
111 | }
112 |
113 | $this->showtotalsifcontainhidden[$course->id] = grade_get_setting($course->id, 'report_planstate_showtotalsifcontainhidden', $CFG->grade_report_planstate_showtotalsifcontainhidden);
114 |
115 | $coursecontext = context_course::instance($course->id);
116 |
117 | foreach ($roleids as $roleid) {
118 | if (user_has_role_assignment($userid, $roleid, $coursecontext->id)) {
119 | $this->studentcourseids[$course->id] = $course->id;
120 | // We only need to check if one of the roleids has been assigned.
121 | break;
122 | }
123 | }
124 |
125 | if (has_capability('moodle/grade:viewall', $coursecontext, $userid)) {
126 | $this->teachercourses[$course->id] = $course;
127 | }
128 | }
129 | }
130 |
131 |
132 | // base url for sorting by first/last name
133 | $this->baseurl = $CFG->wwwroot.'/grade/planstate/index.php?id='.$userid;
134 | $this->pbarurl = $this->baseurl;
135 |
136 | $this->setup_table();
137 | }
138 |
139 | /**
140 | * Prepares the headers and attributes of the flexitable.
141 | */
142 | public function setup_table() {
143 | /*
144 | * Table has 3 columns
145 | *| course | final grade | rank (optional) |
146 | */
147 |
148 | // setting up table headers
149 | if ($this->showrank['any']) {
150 | $tablecolumns = array('coursename', 'grade', 'rank');
151 | $tableheaders = array($this->get_lang_string('coursename', 'grades'),
152 | $this->get_lang_string('grade', 'grades'),
153 | $this->get_lang_string('rank', 'grades'));
154 | } else {
155 | $tablecolumns = array('coursename', 'grade');
156 | $tableheaders = array($this->get_lang_string('coursename', 'grades'),
157 | $this->get_lang_string('grade', 'grades'));
158 | }
159 | $tablecolumns[] = 'completed';
160 | $tableheaders[] = $this->get_lang_string('completed', 'completion');
161 |
162 | $this->table = new flexible_table('grade-report-planstate-'.$this->user->id);
163 |
164 | $this->table->define_columns($tablecolumns);
165 | $this->table->define_headers($tableheaders);
166 | $this->table->define_baseurl($this->baseurl);
167 |
168 | $this->table->set_attribute('cellspacing', '0');
169 | $this->table->set_attribute('id', 'planstate-grade');
170 | $this->table->set_attribute('class', 'boxaligncenter generaltable');
171 |
172 | $this->table->setup();
173 | }
174 |
175 | /**
176 | * Set up the courses grades data for the report.
177 | *
178 | * @param bool $studentcoursesonly Only show courses that the user is a student of.
179 | * @return array of course grades information
180 | */
181 | public function setup_courses_data($studentcoursesonly) {
182 | global $USER, $DB;
183 |
184 | $coursesdata = array();
185 | $numusers = $this->get_numusers(false);
186 |
187 | foreach ($this->courses as $course) {
188 | if (!$course->showgrades) {
189 | continue;
190 | }
191 |
192 | // If we are only showing student courses and this course isn't part of the group, then move on.
193 | if ($studentcoursesonly && !isset($this->studentcourseids[$course->id])) {
194 | continue;
195 | }
196 |
197 | $coursecontext = context_course::instance($course->id);
198 |
199 | if (!$course->visible && !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
200 | // The course is hidden and the user isn't allowed to see it.
201 | continue;
202 | }
203 |
204 | if (!has_capability('moodle/user:viewuseractivitiesreport', context_user::instance($this->user->id)) &&
205 | ((!has_capability('moodle/grade:view', $coursecontext) || $this->user->id != $USER->id) &&
206 | !has_capability('moodle/grade:viewall', $coursecontext))) {
207 | continue;
208 | }
209 |
210 | $coursesdata[$course->id]['course'] = $course;
211 | $coursesdata[$course->id]['context'] = $coursecontext;
212 |
213 | $canviewhidden = has_capability('moodle/grade:viewhidden', $coursecontext);
214 |
215 | // Get course grade_item.
216 | $courseitem = grade_item::fetch_course_item($course->id);
217 |
218 | // Get the stored grade.
219 | $coursegrade = new grade_grade(array('itemid' => $courseitem->id, 'userid' => $this->user->id));
220 | $coursegrade->grade_item =& $courseitem;
221 | $finalgrade = $coursegrade->finalgrade;
222 |
223 | if (!$canviewhidden and !is_null($finalgrade)) {
224 | if ($coursegrade->is_hidden()) {
225 | $finalgrade = null;
226 | } else {
227 | $adjustedgrade = $this->blank_hidden_total_and_adjust_bounds($course->id,
228 | $courseitem,
229 | $finalgrade);
230 |
231 | // We temporarily adjust the view of this grade item - because the min and
232 | // max are affected by the hidden values in the aggregation.
233 | $finalgrade = $adjustedgrade['grade'];
234 | $courseitem->grademax = $adjustedgrade['grademax'];
235 | $courseitem->grademin = $adjustedgrade['grademin'];
236 | }
237 | } else {
238 | // We must use the specific max/min because it can be different for
239 | // each grade_grade when items are excluded from sum of grades.
240 | if (!is_null($finalgrade)) {
241 | $courseitem->grademin = $coursegrade->get_grade_min();
242 | $courseitem->grademax = $coursegrade->get_grade_max();
243 | }
244 | }
245 |
246 | $coursesdata[$course->id]['finalgrade'] = $finalgrade;
247 | $coursesdata[$course->id]['courseitem'] = $courseitem;
248 |
249 | if ($this->showrank['any'] && $this->showrank[$course->id] && !is_null($finalgrade)) {
250 | // Find the number of users with a higher grade.
251 | // Please note this can not work if hidden grades involved :-( to be fixed in 2.0.
252 | $params = array($finalgrade, $courseitem->id);
253 | $sql = "SELECT COUNT(DISTINCT(userid))
254 | FROM {grade_grades}
255 | WHERE finalgrade IS NOT NULL AND finalgrade > ?
256 | AND itemid = ?";
257 | $rank = $DB->count_records_sql($sql, $params) + 1;
258 |
259 | $coursesdata[$course->id]['rank'] = $rank;
260 | $coursesdata[$course->id]['numusers'] = $numusers;
261 | }
262 |
263 | if ($course->enablecompletion) {
264 | $completed = $DB->get_record('course_completions', array('course' => $course->id, 'userid' => $this->user->id));
265 |
266 | $coursesdata[$course->id]['completed'] = $completed->timecompleted ? $completed->timecompleted : false;
267 | } else {
268 | $coursesdata[$course->id]['completed'] = null;
269 | }
270 | }
271 | return $coursesdata;
272 | }
273 |
274 | /**
275 | * Fill the table for displaying.
276 | *
277 | * @param bool $activitylink If this report link to the activity report or the user report.
278 | * @param bool $studentcoursesonly Only show courses that the user is a student of.
279 | */
280 | public function fill_table($activitylink = false, $studentcoursesonly = false) {
281 | global $CFG, $DB, $OUTPUT, $USER;
282 |
283 | if ($studentcoursesonly && count($this->studentcourseids) == 0) {
284 | return false;
285 | }
286 |
287 | // Only show user's courses instead of all courses.
288 | if ($this->courses) {
289 | $coursesdata = $this->setup_courses_data($studentcoursesonly);
290 | $timedateformat = get_string('strftimedatetimeshort');
291 |
292 | foreach ($coursesdata as $coursedata) {
293 |
294 | $course = $coursedata['course'];
295 | $coursecontext = $coursedata['context'];
296 | $finalgrade = $coursedata['finalgrade'];
297 | $courseitem = $coursedata['courseitem'];
298 |
299 | $coursename = format_string(get_course_display_name_for_list($course), true, array('context' => $coursecontext));
300 | // Link to the activity report version of the user grade report.
301 | if ($activitylink) {
302 | $courselink = html_writer::link(new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id,
303 | 'user' => $this->user->id)), $coursename);
304 | } else {
305 | $courselink = html_writer::link(new moodle_url('/grade/report/user/index.php', array('id' => $course->id,
306 | 'userid' => $this->user->id, 'group' => $this->gpr->groupid)), $coursename);
307 | }
308 |
309 | $data = array($courselink, grade_format_gradevalue($finalgrade, $courseitem, true));
310 |
311 | if ($this->showrank['any']) {
312 | if ($this->showrank[$course->id] && !is_null($finalgrade)) {
313 | $rank = $coursedata['rank'];
314 | $numusers = $coursedata['numusers'];
315 | $data[] = "$rank/$numusers";
316 | } else {
317 | // No grade, no rank.
318 | // Or this course wants rank hidden.
319 | $data[] = '-';
320 | }
321 | }
322 |
323 | $completed = $coursedata['completed'];
324 | $data[] = $completed === null ? '-' : ($completed === false ? 'No' : userdate($completed, $timedateformat));
325 |
326 | $this->table->add_data($data);
327 | }
328 |
329 | return true;
330 | } else {
331 | echo $OUTPUT->notification(get_string('notenrolled', 'grades'), 'notifymessage');
332 | return false;
333 | }
334 | }
335 |
336 | /**
337 | * Prints or returns the HTML from the flexitable.
338 | * @param bool $return Whether or not to return the data instead of printing it directly.
339 | * @return string
340 | */
341 | public function print_table($return=false) {
342 | ob_start();
343 | $this->table->print_html();
344 | $html = ob_get_clean();
345 | if ($return) {
346 | return $html;
347 | } else {
348 | echo $html;
349 | }
350 | }
351 |
352 | /**
353 | * Print a table to show courses that the user is able to grade.
354 | */
355 | public function print_teacher_table() {
356 | $table = new html_table();
357 | $table->head = array(get_string('coursename', 'grades'));
358 | $table->data = null;
359 | foreach ($this->teachercourses as $courseid => $course) {
360 | $url = new moodle_url('/grade/report/index.php', array('id' => $courseid));
361 | $table->data[] = array(html_writer::link($url, $course->fullname));
362 | }
363 | echo html_writer::table($table);
364 | }
365 |
366 | /**
367 | * Processes the data sent by the form (grades and feedbacks).
368 | * @param array $data
369 | * @return bool Success or Failure (array of errors).
370 | */
371 | function process_data($data) {
372 | }
373 | function process_action($target, $action) {
374 | }
375 |
376 | /**
377 | * This report supports being set as the 'grades' report.
378 | */
379 | public static function supports_mygrades() {
380 | return true;
381 | }
382 |
383 | /**
384 | * Check if the user can access the report.
385 | *
386 | * @param stdClass $systemcontext system context
387 | * @param stdClass $context course context
388 | * @param stdClass $personalcontext personal context
389 | * @param stdClass $course course object
390 | * @param int $userid userid
391 | * @return bool true if the user can access the report
392 | * @since Moodle 3.2
393 | */
394 | public static function check_access($systemcontext, $context, $personalcontext, $course, $userid) {
395 | global $USER;
396 |
397 | $access = false;
398 | if (has_capability('moodle/grade:viewall', $systemcontext)) {
399 | // Ok - can view all course grades.
400 | $access = true;
401 |
402 | } else if (has_capability('moodle/grade:viewall', $context)) {
403 | // Ok - can view any grades in context.
404 | $access = true;
405 |
406 | } else if ($userid == $USER->id and ((has_capability('moodle/grade:view', $context) and $course->showgrades)
407 | || $course->id == SITEID)) {
408 | // Ok - can view own course grades.
409 | $access = true;
410 |
411 | } else if (has_capability('moodle/grade:viewall', $personalcontext) and $course->showgrades) {
412 | // Ok - can view grades of this user - parent most probably.
413 | $access = true;
414 | } else if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext) and $course->showgrades) {
415 | // Ok - can view grades of this user - parent most probably.
416 | $access = true;
417 | }
418 | return $access;
419 | }
420 |
421 | /**
422 | * Trigger the grade_report_viewed event
423 | *
424 | * @param stdClass $context course context
425 | * @param int $courseid course id
426 | * @param int $userid user id
427 | * @since Moodle 3.2
428 | */
429 | public static function viewed($context, $courseid, $userid) {
430 | $event = \gradereport_planstate\event\grade_report_viewed::create(
431 | array(
432 | 'context' => $context,
433 | 'courseid' => $courseid,
434 | 'relateduserid' => $userid,
435 | )
436 | );
437 | $event->trigger();
438 | }
439 | }
440 |
441 | function grade_report_planstate_settings_definition(&$mform) {
442 | global $CFG;
443 |
444 | //show rank
445 | $options = array(-1 => get_string('default', 'grades'),
446 | 0 => get_string('hide'),
447 | 1 => get_string('show'));
448 |
449 | if (empty($CFG->grade_report_planstate_showrank)) {
450 | $options[-1] = get_string('defaultprev', 'grades', $options[0]);
451 | } else {
452 | $options[-1] = get_string('defaultprev', 'grades', $options[1]);
453 | }
454 |
455 | $mform->addElement('select', 'report_planstate_showrank', get_string('showrank', 'grades'), $options);
456 | $mform->addHelpButton('report_planstate_showrank', 'showrank', 'grades');
457 |
458 | //showtotalsifcontainhidden
459 | $options = array(-1 => get_string('default', 'grades'),
460 | GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'),
461 | GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'),
462 | GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') );
463 |
464 | if (!array_key_exists($CFG->grade_report_planstate_showtotalsifcontainhidden, $options)) {
465 | $options[-1] = get_string('defaultprev', 'grades', $options[0]);
466 | } else {
467 | $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_planstate_showtotalsifcontainhidden]);
468 | }
469 |
470 | $mform->addElement('select', 'report_planstate_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), $options);
471 | $mform->addHelpButton('report_planstate_showtotalsifcontainhidden', 'hidetotalifhiddenitems', 'grades');
472 | }
473 |
474 | /**
475 | * Add nodes to myprofile page.
476 | *
477 | * @param \core_user\output\myprofile\tree $tree Tree object
478 | * @param stdClass $user user object
479 | * @param bool $iscurrentuser
480 | * @param stdClass $course Course object
481 | */
482 | function gradereport_planstate_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) {
483 | if (empty($course)) {
484 | // We want to display these reports under the site context.
485 | $course = get_fast_modinfo(SITEID)->get_course();
486 | }
487 | $systemcontext = context_system::instance();
488 | $usercontext = context_user::instance($user->id);
489 | $coursecontext = context_course::instance($course->id);
490 | if (grade_report_planstate::check_access($systemcontext, $coursecontext, $usercontext, $course, $user->id)) {
491 | $url = new moodle_url('/grade/report/planstate/index.php', array('userid' => $user->id, 'id' => $course->id));
492 | $node = new core_user\output\myprofile\node('reports', 'planstate', get_string('gradesplanstate', 'gradereport_planstate'),
493 | null, $url);
494 | $tree->add_node($node);
495 | }
496 | }
497 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
676 |
--------------------------------------------------------------------------------