mirror of
https://github.com/moodle/moodle.git
synced 2025-03-23 17:10:20 +01:00
Merge branch 'MDL-69259-master' of git://github.com/ilyatregubov/moodle
This commit is contained in:
Andrew Nicols
commit
6b23a271b8
277
mod/h5pactivity/classes/external/get_user_attempts.php
vendored
Normal file
277
mod/h5pactivity/classes/external/get_user_attempts.php
vendored
Normal file
@ -0,0 +1,277 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* This is the external method to return the information needed to list all enrolled user attempts.
|
||||
*
|
||||
* @package mod_h5pactivity
|
||||
* @since Moodle 3.11
|
||||
* @copyright 2020 Ilya Tregubov <ilya@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace mod_h5pactivity\external;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
global $CFG;
|
||||
require_once($CFG->libdir . '/externallib.php');
|
||||
|
||||
use mod_h5pactivity\local\manager;
|
||||
use mod_h5pactivity\local\attempt;
|
||||
use mod_h5pactivity\local\report;
|
||||
use mod_h5pactivity\local\report\attempts as report_attempts;
|
||||
use external_api;
|
||||
use external_function_parameters;
|
||||
use external_value;
|
||||
use external_multiple_structure;
|
||||
use external_single_structure;
|
||||
use external_warnings;
|
||||
use moodle_exception;
|
||||
use context_module;
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* This is the external method to return the information needed to list all enrolled user attempts.
|
||||
*
|
||||
* @copyright 2020 Ilya Tregubov <ilya@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class get_user_attempts extends external_api {
|
||||
|
||||
/**
|
||||
* Webservice parameters.
|
||||
*
|
||||
* @return external_function_parameters
|
||||
*/
|
||||
public static function execute_parameters(): external_function_parameters {
|
||||
return new external_function_parameters(
|
||||
[
|
||||
'h5pactivityid' => new external_value(PARAM_INT, 'h5p activity instance id'),
|
||||
'sortorder' => new external_value(PARAM_TEXT,
|
||||
'sort by this element: id, firstname', VALUE_DEFAULT, 'id ASC'),
|
||||
'page' => new external_value(PARAM_INT, 'current page', VALUE_DEFAULT, -1),
|
||||
'perpage' => new external_value(PARAM_INT, 'items per page', VALUE_DEFAULT, 0),
|
||||
'firstinitial' => new external_value(PARAM_TEXT, 'Users whose first name ' .
|
||||
'starts with $firstinitial', VALUE_DEFAULT, ''),
|
||||
'lastinitial' => new external_value(PARAM_TEXT, 'Users whose last name ' .
|
||||
'starts with $lastinitial', VALUE_DEFAULT, ''),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return user attempts information in a h5p activity.
|
||||
*
|
||||
* @throws moodle_exception if the user cannot see the report
|
||||
* @param int $h5pactivityid The h5p activity id
|
||||
* @param int $sortorder The sort order
|
||||
* @param int $page page number
|
||||
* @param int $perpage items per page
|
||||
* @param int $firstinitial Users whose first name starts with $firstinitial
|
||||
* @param int $lastinitial Users whose last name starts with $lastinitial
|
||||
* @return stdClass report data
|
||||
*/
|
||||
public static function execute(int $h5pactivityid, $sortorder = '', ?int $page = 0,
|
||||
?int $perpage = 0, $firstinitial = '', $lastinitial = ''): stdClass {
|
||||
[
|
||||
'h5pactivityid' => $h5pactivityid,
|
||||
'sortorder' => $sortorder,
|
||||
'page' => $page,
|
||||
'perpage' => $perpage,
|
||||
'firstinitial' => $firstinitial,
|
||||
'lastinitial' => $lastinitial,
|
||||
] = external_api::validate_parameters(self::execute_parameters(), [
|
||||
'h5pactivityid' => $h5pactivityid,
|
||||
'sortorder' => $sortorder,
|
||||
'page' => $page,
|
||||
'perpage' => $perpage,
|
||||
'firstinitial' => $firstinitial,
|
||||
'lastinitial' => $lastinitial,
|
||||
]);
|
||||
|
||||
$warnings = [];
|
||||
|
||||
[$course, $cm] = get_course_and_cm_from_instance($h5pactivityid, 'h5pactivity');
|
||||
|
||||
$context = context_module::instance($cm->id);
|
||||
self::validate_context($context);
|
||||
|
||||
$manager = manager::create_from_coursemodule($cm);
|
||||
$instance = $manager->get_instance();
|
||||
if (!$manager->can_view_all_attempts()) {
|
||||
throw new moodle_exception('nopermissiontoviewattempts', 'error', '', null,
|
||||
'h5pactivity:reviewattempts required view attempts of all enrolled users.');
|
||||
}
|
||||
|
||||
$coursecontext = \context_course::instance($course->id);
|
||||
|
||||
$users = get_enrolled_users($coursecontext, '', 0, 'u.id, u.firstname, u.lastname',
|
||||
$sortorder, $page * $perpage, $perpage);
|
||||
|
||||
$usersattempts = [];
|
||||
|
||||
foreach ($users as $user) {
|
||||
|
||||
if ($firstinitial) {
|
||||
if (strpos($user->firstname, $firstinitial) === false) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
if ($lastinitial) {
|
||||
if (strpos($user->lastname, $lastinitial) === false) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
$report = $manager->get_report($user->id);
|
||||
if ($report && $report instanceof report_attempts) {
|
||||
$usersattempts[] = self::export_user_attempts($report, $user->id);
|
||||
} else {
|
||||
$warnings[] = [
|
||||
'item' => 'user',
|
||||
'itemid' => $user->id,
|
||||
'warningcode' => '1',
|
||||
'message' => "Cannot access user attempts",
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
$result = (object)[
|
||||
'activityid' => $instance->id,
|
||||
'usersattempts' => $usersattempts,
|
||||
'warnings' => $warnings,
|
||||
];
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Export attempts data for a specific user.
|
||||
*
|
||||
* @param report $report the report attempts object
|
||||
* @param int $userid the user id
|
||||
* @return stdClass
|
||||
*/
|
||||
private static function export_user_attempts(report $report, int $userid): stdClass {
|
||||
$scored = $report->get_scored();
|
||||
$attempts = $report->get_attempts();
|
||||
|
||||
$result = (object)[
|
||||
'userid' => $userid,
|
||||
'attempts' => [],
|
||||
];
|
||||
|
||||
foreach ($attempts as $attempt) {
|
||||
$result->attempts[] = self::export_attempt($attempt);
|
||||
}
|
||||
|
||||
if (!empty($scored)) {
|
||||
$result->scored = (object)[
|
||||
'title' => $scored->title,
|
||||
'grademethod' => $scored->grademethod,
|
||||
'attempts' => [self::export_attempt($scored->attempt)],
|
||||
];
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a data object from an attempt.
|
||||
*
|
||||
* @param attempt $attempt the attempt object
|
||||
* @return stdClass a WS compatible version of the attempt
|
||||
*/
|
||||
private static function export_attempt(attempt $attempt): stdClass {
|
||||
$result = (object)[
|
||||
'id' => $attempt->get_id(),
|
||||
'h5pactivityid' => $attempt->get_h5pactivityid(),
|
||||
'userid' => $attempt->get_userid(),
|
||||
'timecreated' => $attempt->get_timecreated(),
|
||||
'timemodified' => $attempt->get_timemodified(),
|
||||
'attempt' => $attempt->get_attempt(),
|
||||
'rawscore' => $attempt->get_rawscore(),
|
||||
'maxscore' => $attempt->get_maxscore(),
|
||||
'duration' => $attempt->get_duration(),
|
||||
'scaled' => $attempt->get_scaled(),
|
||||
];
|
||||
if ($attempt->get_completion() !== null) {
|
||||
$result->completion = $attempt->get_completion();
|
||||
}
|
||||
if ($attempt->get_success() !== null) {
|
||||
$result->success = $attempt->get_success();
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes the get_h5pactivity_access_information return value.
|
||||
*
|
||||
* @return external_single_structure
|
||||
*/
|
||||
public static function execute_returns(): external_single_structure {
|
||||
return new external_single_structure([
|
||||
'activityid' => new external_value(PARAM_INT, 'Activity course module ID'),
|
||||
'usersattempts' => new external_multiple_structure(
|
||||
self::get_user_attempts_returns(), 'The complete users attempts list'
|
||||
),
|
||||
'warnings' => new external_warnings(),
|
||||
], 'Activity attempts data');
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes the get_h5pactivity_access_information return value.
|
||||
*
|
||||
* @return external_single_structure
|
||||
*/
|
||||
private static function get_user_attempts_returns(): external_single_structure {
|
||||
$structure = [
|
||||
'userid' => new external_value(PARAM_INT, 'The user id'),
|
||||
'attempts' => new external_multiple_structure(self::get_user_attempt_returns(), 'The complete attempts list'),
|
||||
'scored' => new external_single_structure([
|
||||
'title' => new external_value(PARAM_NOTAGS, 'Scored attempts title'),
|
||||
'grademethod' => new external_value(PARAM_NOTAGS, 'Grading method'),
|
||||
'attempts' => new external_multiple_structure(self::get_user_attempt_returns(), 'List of the grading attempts'),
|
||||
], 'Attempts used to grade the activity', VALUE_OPTIONAL),
|
||||
];
|
||||
return new external_single_structure($structure);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the external structure of an attempt.
|
||||
*
|
||||
* @return external_single_structure
|
||||
*/
|
||||
private static function get_user_attempt_returns(): external_single_structure {
|
||||
$result = new external_single_structure([
|
||||
'id' => new external_value(PARAM_INT, 'ID of the context'),
|
||||
'h5pactivityid' => new external_value(PARAM_INT, 'ID of the H5P activity'),
|
||||
'userid' => new external_value(PARAM_INT, 'ID of the user'),
|
||||
'timecreated' => new external_value(PARAM_INT, 'Attempt creation'),
|
||||
'timemodified' => new external_value(PARAM_INT, 'Attempt modified'),
|
||||
'attempt' => new external_value(PARAM_INT, 'Attempt number'),
|
||||
'rawscore' => new external_value(PARAM_INT, 'Attempt score value'),
|
||||
'maxscore' => new external_value(PARAM_INT, 'Attempt max score'),
|
||||
'duration' => new external_value(PARAM_INT, 'Attempt duration in seconds'),
|
||||
'completion' => new external_value(PARAM_INT, 'Attempt completion', VALUE_OPTIONAL),
|
||||
'success' => new external_value(PARAM_INT, 'Attempt success', VALUE_OPTIONAL),
|
||||
'scaled' => new external_value(PARAM_FLOAT, 'Attempt scaled'),
|
||||
]);
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@ -78,7 +78,16 @@ $functions = [
|
||||
'methodname' => 'execute',
|
||||
'classpath' => '',
|
||||
'description' => 'Log that the h5pactivity was viewed.',
|
||||
'type' => 'write',
|
||||
'type' => 'write',
|
||||
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
|
||||
],
|
||||
'mod_h5pactivity_get_user_attempts' => [
|
||||
'classname' => 'mod_h5pactivity\external\get_user_attempts',
|
||||
'methodname' => 'execute',
|
||||
'classpath' => '',
|
||||
'description' => 'Return the information needed to list all enrolled user attempts.',
|
||||
'type' => 'read',
|
||||
'capabilities' => 'mod/h5pactivity:reviewattempts',
|
||||
'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
|
||||
],
|
||||
];
|
||||
|
||||
185
mod/h5pactivity/tests/external/get_user_attempts_test.php
vendored
Normal file
185
mod/h5pactivity/tests/external/get_user_attempts_test.php
vendored
Normal file
@ -0,0 +1,185 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* External function test for get_user_attempts.
|
||||
*
|
||||
* @package mod_h5pactivity
|
||||
* @category external
|
||||
* @since Moodle 3.11
|
||||
* @copyright 2020 Ilya Tregubov <ilya@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
namespace mod_h5pactivity\external;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
global $CFG;
|
||||
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
|
||||
|
||||
use mod_h5pactivity\local\manager;
|
||||
use external_api;
|
||||
use externallib_advanced_testcase;
|
||||
|
||||
/**
|
||||
* External function test for get_user_attempts.
|
||||
*
|
||||
* @package mod_h5pactivity
|
||||
* @copyright 2020 Ilya Tregubov <ilya@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class get_user_attempts_testcase extends externallib_advanced_testcase {
|
||||
|
||||
/**
|
||||
* Test the behaviour of get_user_attempts getting more than one user at once.
|
||||
*
|
||||
* @dataProvider execute_multipleusers_data
|
||||
* @param string $loginuser the user which calls the webservice
|
||||
* @param string[] $participants the users to get the data
|
||||
* @param string[] $warnings the expected users with warnings
|
||||
* @param string[] $resultusers expected users in the resultusers
|
||||
*/
|
||||
public function test_execute_multipleusers(string $loginuser, array $participants,
|
||||
array $warnings, array $resultusers): void {
|
||||
$this->resetAfterTest();
|
||||
$this->setAdminUser();
|
||||
|
||||
$course = $this->getDataGenerator()->create_course();
|
||||
$activity = $this->getDataGenerator()->create_module('h5pactivity',
|
||||
['course' => $course]);
|
||||
|
||||
$manager = manager::create_from_instance($activity);
|
||||
$cm = $manager->get_coursemodule();
|
||||
|
||||
$users = ['editingteacher' => $this->getDataGenerator()->create_and_enrol($course, 'editingteacher')];
|
||||
|
||||
// Prepare users.
|
||||
foreach ($participants as $participant) {
|
||||
if ($participant == 'noenrolled') {
|
||||
$users[$participant] = $this->getDataGenerator()->create_user();
|
||||
} else {
|
||||
$users[$participant] = $this->getDataGenerator()->create_and_enrol($course, 'student');
|
||||
}
|
||||
}
|
||||
|
||||
// Generate attempts (student1 with 1 attempt, student2 with 2 etc).
|
||||
$generator = $this->getDataGenerator()->get_plugin_generator('mod_h5pactivity');
|
||||
|
||||
$attemptcount = 1;
|
||||
foreach ($users as $key => $user) {
|
||||
if (($key == 'noattempts') || ($key == 'noenrolled') || ($key == 'editingteacher')) {
|
||||
$countattempts[$user->id] = 0;
|
||||
} else {
|
||||
$params = ['cmid' => $cm->id, 'userid' => $user->id];
|
||||
for ($i = 1; $i <= $attemptcount; $i++) {
|
||||
$generator->create_content($activity, $params);
|
||||
}
|
||||
$countattempts[$user->id] = $attemptcount;
|
||||
$attemptcount++;
|
||||
}
|
||||
}
|
||||
|
||||
// Execute external method.
|
||||
$this->setUser($users[$loginuser]);
|
||||
|
||||
if ($loginuser == 'student1') {
|
||||
$this->expectException('moodle_exception');
|
||||
$this->expectExceptionMessage('h5pactivity:reviewattempts required view attempts' .
|
||||
' of all enrolled users');
|
||||
}
|
||||
$result = get_user_attempts::execute($activity->id);
|
||||
$result = external_api::clean_returnvalue(
|
||||
get_user_attempts::execute_returns(),
|
||||
$result
|
||||
);
|
||||
|
||||
$this->assertCount(count($warnings), $result['warnings']);
|
||||
// Teacher is excluded.
|
||||
$this->assertCount(count($resultusers), $result['usersattempts']);
|
||||
|
||||
$expectedwarnings = [];
|
||||
foreach ($warnings as $warninguser) {
|
||||
$id = $users[$warninguser]->id;
|
||||
$expectedwarnings[$id] = $warninguser;
|
||||
}
|
||||
|
||||
foreach ($result['warnings'] as $warning) {
|
||||
$this->assertEquals('user', $warning['item']);
|
||||
$this->assertEquals(1, $warning['warningcode']);
|
||||
$this->assertArrayHasKey($warning['itemid'], $expectedwarnings);
|
||||
}
|
||||
|
||||
$expectedusers = [];
|
||||
foreach ($resultusers as $resultuser) {
|
||||
$id = $users[$resultuser]->id;
|
||||
$expectedusers[$id] = $resultuser;
|
||||
}
|
||||
|
||||
foreach ($result['usersattempts'] as $usersattempts) {
|
||||
$this->assertArrayHasKey('userid', $usersattempts);
|
||||
$userid = $usersattempts['userid'];
|
||||
$this->assertArrayHasKey($userid, $expectedusers);
|
||||
$this->assertCount($countattempts[$userid], $usersattempts['attempts']);
|
||||
if ($countattempts[$userid]) {
|
||||
$this->assertArrayHasKey('scored', $usersattempts);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for the test_execute_multipleusers.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function execute_multipleusers_data(): array {
|
||||
return [
|
||||
// Teacher checks.
|
||||
'Teacher checking students with attempts' => [
|
||||
'editingteacher',
|
||||
['student1', 'student2', 'student3', 'student4', 'student5'],
|
||||
['editingteacher'],
|
||||
['student1', 'student2', 'student3', 'student4', 'student5'],
|
||||
],
|
||||
'Teacher checking 2 students with atempts and one not' => [
|
||||
'editingteacher',
|
||||
['student1', 'student2', 'noattempts'],
|
||||
['editingteacher'],
|
||||
['student1', 'student2', 'noattempts'],
|
||||
],
|
||||
'Teacher checking no students' => [
|
||||
'editingteacher',
|
||||
[],
|
||||
['editingteacher'],
|
||||
[],
|
||||
],
|
||||
'Teacher checking one student and a no enrolled user' => [
|
||||
'editingteacher',
|
||||
['student1', 'noenrolled'],
|
||||
['editingteacher'],
|
||||
['student1'],
|
||||
],
|
||||
|
||||
// Permission check.
|
||||
'Student checking attempts and another user' => [
|
||||
'student1',
|
||||
['student1', 'student2'],
|
||||
['student2'],
|
||||
['student1'],
|
||||
],
|
||||
];
|
||||
}
|
||||
}
|
||||
@ -25,5 +25,5 @@
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
$plugin->component = 'mod_h5pactivity';
|
||||
$plugin->version = 2021052501;
|
||||
$plugin->version = 2021052502;
|
||||
$plugin->requires = 2021052500;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user