moodle_local_treestudyplan/classes/courseservice.php

521 lines
19 KiB
PHP
Raw Normal View History

<?php
2023-08-24 23:02:41 +02:00
// This file is part of the Studyplan plugin for Moodle
//
// 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 <https://www.gnu.org/licenses/>.
/**
2023-08-27 21:23:39 +02:00
* Webservice related to courses
2023-08-24 23:02:41 +02:00
* @package local_treestudyplan
* @copyright 2023 P.M. Kuipers
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace local_treestudyplan;
2023-08-25 12:04:27 +02:00
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir.'/externallib.php');
use \local_treestudyplan\courseinfo;
use \local_treestudyplan\associationservice;
use \local_treestudyplan\local\helpers\webservicehelper;
use \local_treestudyplan\completionscanner;
use \local_treestudyplan\gradingscanner;
2023-08-27 21:23:39 +02:00
use \core_course_category;
2023-08-27 21:23:39 +02:00
/**
* Webservice related to courses
*/
2023-08-25 10:41:56 +02:00
class courseservice extends \external_api {
2023-08-27 21:23:39 +02:00
/**
* Capability required to edit study plans
* @var string
*/
const CAP_EDIT = "local/treestudyplan:editstudyplan";
2023-08-27 21:23:39 +02:00
/**
* Capability required to view studyplans (for other users)
* @var string
*/
const CAP_VIEW = "local/treestudyplan:viewuserreports";
2023-08-27 21:23:39 +02:00
/**
* Return value description for map_categories function
*/
2023-08-28 08:51:52 +02:00
public static function map_categories_parameters() : \external_function_parameters {
return new \external_function_parameters( [
"root_id" => new \external_value(PARAM_INT, 'root category to use as base', VALUE_DEFAULT),
] );
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for map_categories function
*/
2023-08-28 08:51:52 +02:00
public static function map_categories_returns() : \external_description {
return new \external_multiple_structure(static::map_category_structure(false));
}
2023-08-27 21:23:39 +02:00
/**
* Structure description for category map, used in a number of return descriptions
* @param bool $lazy
* @param int $value
*/
2023-08-25 13:04:19 +02:00
protected static function map_category_structure($lazy = false, $value = VALUE_REQUIRED) {
$s = [
"id" => new \external_value(PARAM_INT, 'course category id'),
"context_id" => new \external_value(PARAM_INT, 'course category context id'),
2023-08-25 10:41:56 +02:00
"category" => contextinfo::structure(VALUE_OPTIONAL),
2023-08-25 12:16:51 +02:00
"haschildren" => new \external_value(PARAM_BOOL, 'true if the category has child categories'),
"hascourses" => new \external_value(PARAM_BOOL, 'true if the category contains courses'),
2023-08-25 10:41:56 +02:00
"studyplancount" => new \external_value(PARAM_INT, 'number of linked studyplans', VALUE_OPTIONAL),
];
2023-08-24 23:02:41 +02:00
if (!$lazy > 0) {
$s["courses"] = new \external_multiple_structure( courseinfo::editor_structure() );
$s["children"] = new \external_multiple_structure( static::map_category_structure(true));
}
2023-08-24 23:02:41 +02:00
return new \external_single_structure($s, "CourseCat info", $value);
}
2023-08-27 21:23:39 +02:00
/**
* Get a category map, and optionally specify a root category to search for
* User's top category will be used if none specified
* @param int $rootid Optional starting category for the map
* @return array
*/
2023-08-25 09:33:42 +02:00
public static function map_categories($rootid = 0) {
global $CFG, $DB;
2023-08-25 09:33:42 +02:00
$root = \core_course_category::get($rootid);
$context = $root->get_context();
2023-08-24 23:02:41 +02:00
// Make sure the user has access to the context for editing purposes.
webservicehelper::require_capabilities(self::CAP_EDIT, $context);
2023-08-24 23:02:41 +02:00
// Determine top categories from provided context.
2023-08-24 23:02:41 +02:00
if ($root->id == 0) {
2023-08-25 09:44:34 +02:00
// On the system level, determine the user's topmost allowed catecories.
2023-08-25 09:33:42 +02:00
$usertop = \core_course_category::user_top();
2023-08-25 10:41:56 +02:00
if ($usertop->id == 0) {
// Top category..
$children = $root->get_children(); // Returns a list of çore_course_category, let it overwrite $children.
} else {
2023-08-25 09:33:42 +02:00
$children = [$usertop];
}
2023-08-24 23:02:41 +02:00
} else if ($root->is_uservisible()) {
$children = [$root];
2023-08-24 23:02:41 +02:00
}
2023-08-24 23:02:41 +02:00
foreach ($children as $cat) {
$list[] = static::map_category($cat, false);
}
return $list;
2023-08-24 23:02:41 +02:00
}
2023-08-27 21:23:39 +02:00
/**
* Return value description for get_category function
*/
2023-08-28 08:51:52 +02:00
public static function get_category_parameters() : \external_function_parameters {
return new \external_function_parameters( [
"id" => new \external_value(PARAM_INT, 'id of category'),
] );
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for get_category function
*/
2023-08-28 08:51:52 +02:00
public static function get_category_returns() : \external_description {
return static::map_category_structure(false);
}
2023-08-27 21:23:39 +02:00
/**
* Get category info by id
* @param mixed $id
* @return array
*/
2023-08-24 23:02:41 +02:00
public static function get_category($id) {
$cat = \core_course_category::get($id);
return static::map_category($cat);
2023-08-24 23:02:41 +02:00
}
2023-08-27 21:23:39 +02:00
/**
* Create a category map, given a specific category
* @param core_course_category $cat The category to scan
* @param bool $lazy If lazy loading, do not scan child categories
* @return array
*/
protected static function map_category(core_course_category $cat, $lazy = false) {
global $DB;
$catcontext = $cat->get_context();
2023-08-25 09:33:42 +02:00
$ctxinfo = new contextinfo($catcontext);
2023-08-25 10:41:56 +02:00
$children = $cat->get_children(); // Only shows children visible to the current user.
$courses = $cat->get_courses();
$model = [
"id" => $cat->id,
"context_id" => $catcontext->id,
2023-08-25 09:33:42 +02:00
"category" => $ctxinfo->model(),
"haschildren" => !empty($children),
"hascourses" => !empty($courses),
];
2023-08-24 23:02:41 +02:00
if (!$lazy) {
$model["courses"] = [];
2023-08-24 23:02:41 +02:00
foreach ($courses as $course) {
$courseinfo = new courseinfo($course->id);
$model["courses"][] = $courseinfo->editor_model();
}
$model["children"] = [];
2023-08-24 23:02:41 +02:00
foreach ($children as $child) {
$model["children"][] = static::map_category($child, true);
}
}
return $model;
}
2023-08-27 21:23:39 +02:00
/**
* Return value description for list_accessible_categories function
*/
2023-08-28 08:51:52 +02:00
public static function list_accessible_categories_parameters() : \external_function_parameters {
return new \external_function_parameters( [
2023-08-24 23:02:41 +02:00
"operation" => new \external_value(PARAM_TEXT, 'type of operation ["view"|"edit"]', VALUE_DEFAULT), ]
);
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for list_accessible_categories function
*/
2023-08-28 08:51:52 +02:00
public static function list_accessible_categories_returns() : \external_description {
return new \external_multiple_structure(static::map_category_structure(true));
}
2023-08-27 21:23:39 +02:00
/**
* [Description for list_accessible_categories]
* @param string $operation
* @return array
*/
2023-08-25 13:04:19 +02:00
public static function list_accessible_categories($operation = "edit") {
2023-08-24 23:02:41 +02:00
if ($operation == "edit") {
$capability = self::CAP_EDIT;
2023-08-25 09:44:34 +02:00
} else { // Operation == "view" || default.
$capability = self::CAP_VIEW;
}
$cats = static::categories_by_capability($capability);
$list = [];
2023-08-25 13:04:19 +02:00
2023-08-24 23:02:41 +02:00
foreach ($cats as $cat) {
$list[] = static::map_category($cat, true);
}
return $list;
}
2023-08-27 21:23:39 +02:00
/**
* [Description for categories_by_capability]
* @param mixed $capability
* @param core_course_category|null $parent
* @return array
*/
public static function categories_by_capability($capability, core_course_category $parent = null) {
2023-08-24 23:02:41 +02:00
// List the categories in which the user has a specific capability.
$list = [];
2023-08-25 09:44:34 +02:00
// Initialize parent if needed.
2023-08-24 23:02:41 +02:00
if ($parent == null) {
$parent = \core_course_category::user_top();
2023-08-24 23:02:41 +02:00
if (has_capability($capability, $parent->get_context())) {
$list[] = $parent;
}
}
2023-08-24 23:02:41 +02:00
$children = $parent->get_children();
2023-08-24 23:02:41 +02:00
foreach ($children as $child) {
// Check if we should add this category.
if (has_capability($capability, $child->get_context())) {
$list[] = $child;
2023-08-24 23:02:41 +02:00
// For optimization purposes, we include all its children now, since they will have inherited the permission.
// #PREMATURE_OPTIMIZATION ???.
$list = array_merge($list, self::recursive_child_categories($child));
} else {
2023-08-24 23:02:41 +02:00
if ($child->get_children_count() > 0) {
$list = array_merge($list, self::categories_by_capability($capability, $child));
}
}
}
return $list;
}
2023-08-27 21:23:39 +02:00
/**
* Recursively create a list of all categories unter a specified parent
* @param core_course_category $parent
* @return core_course_category[]
*/
protected static function recursive_child_categories(core_course_category $parent) {
$list = [];
$children = $parent->get_children();
2023-08-24 23:02:41 +02:00
foreach ($children as $child) {
$list[] = $child;
2023-08-24 23:02:41 +02:00
if ($child->get_children_count() > 0) {
$list = array_merge($list, self::recursive_child_categories($child));
}
}
return $list;
}
2023-08-27 21:23:39 +02:00
/**
* Return value description for list_used_categories function
*/
2023-08-28 08:51:52 +02:00
public static function list_used_categories_parameters() : \external_function_parameters {
return new \external_function_parameters( [
2023-08-24 23:02:41 +02:00
"operation" => new \external_value(PARAM_TEXT, 'type of operation ["view"|"edit"]', VALUE_DEFAULT),
]);
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for list_used_categories function
*/
2023-08-28 08:51:52 +02:00
public static function list_used_categories_returns() : \external_description {
return new \external_multiple_structure(static::map_category_structure(true));
}
2023-08-27 21:23:39 +02:00
/**
* List all categories available to the current user for editing or viewing studyplans
* @param string $operation The operation to scan usage for [edit, view]
* @return array
*/
2023-08-25 13:04:19 +02:00
public static function list_used_categories($operation = 'edit') {
global $DB;
2023-08-24 23:02:41 +02:00
if ($operation == "edit") {
$capability = self::CAP_EDIT;
2023-08-25 09:44:34 +02:00
} else { // Operation == "view" || default.
$capability = self::CAP_VIEW;
2023-08-24 23:02:41 +02:00
}
2023-08-25 09:33:42 +02:00
$contextids = [];
2023-08-24 23:02:41 +02:00
$rs = $DB->get_recordset_sql("SELECT DISTINCT context_id, COUNT(*) as num FROM {local_treestudyplan}
GROUP BY context_id");
2023-08-24 23:02:41 +02:00
foreach ($rs as $r) {
2023-08-25 09:33:42 +02:00
$contextids[$r->context_id] = $r->num;
}
$rs->close();
2023-08-24 23:02:41 +02:00
// Now filter the categories that the user has acces to by the used context id's.
// (That should filter out irrelevant stuff).
$cats = static::categories_by_capability($capability);
$list = [];
2023-08-24 23:02:41 +02:00
foreach ($cats as $cat) {
$count = 0;
$ctxid = $cat->get_context()->id;
2023-08-25 09:33:42 +02:00
if (array_key_exists($ctxid, $contextids)) {
$count = $contextids[$ctxid];
}
2023-08-24 23:02:41 +02:00
$o = static::map_category($cat, true);
$o["studyplancount"] = $count;
$list[] = $o;
}
return $list;
}
2023-08-27 21:23:39 +02:00
/**
* List all categories available to the current user for editing or viewing studyplans and add information about their usage
* (Not a webservice function)
* @param string $operation
* @return stdClass[]
*/
2023-08-25 13:04:19 +02:00
public static function list_accessible_categories_with_usage($operation = 'edit') {
global $DB;
2023-08-24 23:02:41 +02:00
if ($operation == "edit") {
$capability = self::CAP_EDIT;
2023-08-25 09:44:34 +02:00
} else { // Operation == "view" || default.
$capability = self::CAP_VIEW;
2023-08-24 23:02:41 +02:00
}
2023-08-25 09:44:34 +02:00
// Retrieve context ids used.
2023-08-25 09:33:42 +02:00
$contextids = [];
2023-08-24 23:02:41 +02:00
$rs = $DB->get_recordset_sql("SELECT DISTINCT context_id, COUNT(*) as num FROM {local_treestudyplan}
GROUP BY context_id");
2023-08-24 23:02:41 +02:00
foreach ($rs as $r) {
2023-08-25 09:33:42 +02:00
$contextids[$r->context_id] = $r->num;
}
$rs->close();
2023-08-24 23:02:41 +02:00
// Now filter the categories that the user has acces to by the used context id's.
// (That should filter out irrelevant stuff).
$cats = static::categories_by_capability($capability);
$list = [];
2023-08-24 23:02:41 +02:00
foreach ($cats as $cat) {
$count = 0;
$ctxid = $cat->get_context()->id;
2023-08-25 09:33:42 +02:00
if (array_key_exists($ctxid, $contextids)) {
$count = $contextids[$ctxid];
}
$o = new \stdClass();
$o->cat = $cat;
$o->ctxid = $ctxid;
$o->count = $count;
$list[] = $o;
}
return $list;
}
/**************************************
2023-08-27 22:20:17 +02:00
*
* Progress scanners for teacherview
2023-08-27 22:20:17 +02:00
*
**************************************/
2023-08-27 21:23:39 +02:00
/**
* Return value description for scan_grade_progress function
* @return external_function_parameters
*/
2023-08-28 08:51:52 +02:00
public static function scan_grade_progress_parameters() : \external_function_parameters {
return new \external_function_parameters( [
2023-08-24 23:02:41 +02:00
"gradeitemid" => new \external_value(PARAM_INT, 'Grade item ID to scan progress for', VALUE_DEFAULT),
"studyplanid" => new \external_value(PARAM_INT, 'Study plan id to check progress in', VALUE_DEFAULT),
]);
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for scan_grade_progress function
*/
2023-08-28 08:51:52 +02:00
public static function scan_grade_progress_returns() : \external_description {
2023-08-25 13:04:19 +02:00
return gradingscanner::structure(VALUE_REQUIRED);
}
2023-08-24 23:02:41 +02:00
2023-08-27 21:23:39 +02:00
/**
* Scan grade item for progress statistics
2023-08-27 22:20:17 +02:00
* @param mixed $gradeitemid Grade item id
2023-08-27 21:23:39 +02:00
* @param mixed $studyplanid Id of studyitem the grade is selected in
* @return array
*/
2023-08-24 23:02:41 +02:00
public static function scan_grade_progress($gradeitemid, $studyplanid) {
global $DB;
2023-08-24 23:02:41 +02:00
// Verify access to the study plan.
2023-08-25 17:33:20 +02:00
$o = studyplan::find_by_id($studyplanid);
2023-08-24 23:02:41 +02:00
webservicehelper::require_capabilities(self::CAP_VIEW, $o->context());
// Retrieve grade item.
$gi = \grade_item::fetch(["id" => $gradeitemid]);
2023-08-24 23:02:41 +02:00
// Validate course is linked to studyplan.
$courseid = $gi->courseid;
2023-08-24 23:02:41 +02:00
if (!$o->course_linked($courseid)) {
2023-08-25 11:52:05 +02:00
throw new \webservice_access_exception(
"Course {$courseid} linked to grade item {$gradeitemid} is not linked to studyplan {$o->id()}"
);
}
$scanner = new gradingscanner($gi);
return $scanner->model();
}
2023-08-27 21:23:39 +02:00
/**
* Return value description for scan_completion_progress function
*/
2023-08-28 08:51:52 +02:00
public static function scan_completion_progress_parameters() : \external_function_parameters {
return new \external_function_parameters( [
2023-08-24 23:02:41 +02:00
"criteriaid" => new \external_value(PARAM_INT, 'CriteriaID to scan progress for', VALUE_DEFAULT),
"studyplanid" => new \external_value(PARAM_INT, 'Study plan id to check progress in', VALUE_DEFAULT),
"courseid" => new \external_value(PARAM_INT, 'Course id of criteria', VALUE_DEFAULT),
]);
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for scan_completion_progress function
*/
2023-08-28 08:51:52 +02:00
public static function scan_completion_progress_returns() : \external_description {
return completionscanner::structure(VALUE_REQUIRED);
}
2023-08-27 21:23:39 +02:00
/**
* Scan criterium for progress statistics
* @param mixed $criteriaid Id of criterium
* @param mixed $studyplanid Id of studyplan relevant to this criteria
* @param mixed $courseid Id of course this cirteria is related to
* @return array
*/
2023-08-25 10:41:56 +02:00
public static function scan_completion_progress($criteriaid, $studyplanid, $courseid) {
global $DB;
2023-08-24 23:02:41 +02:00
// Verify access to the study plan.
2023-08-25 17:33:20 +02:00
$o = studyplan::find_by_id($studyplanid);
2023-08-24 23:02:41 +02:00
webservicehelper::require_capabilities(self::CAP_VIEW, $o->context());
$crit = \completion_criteria::fetch(["id" => $criteriaid]);
2023-08-24 23:02:41 +02:00
if (!$o->course_linked($courseid)) {
2023-08-25 11:52:05 +02:00
throw new \webservice_access_exception(
"Course {$courseid} linked to criteria {$criteriaid} is not linked to studyplan {$o->id()}");
}
2023-08-24 23:02:41 +02:00
$scanner = new completionscanner($crit, \get_course($courseid));
return $scanner->model();
}
2023-08-27 21:23:39 +02:00
/**
* Return value description for scan_badge_progress function
*/
2023-08-28 08:51:52 +02:00
public static function scan_badge_progress_parameters() : \external_function_parameters {
return new \external_function_parameters( [
2023-08-24 23:02:41 +02:00
"badgeid" => new \external_value(PARAM_INT, 'Badge to scan progress for', VALUE_DEFAULT),
2023-08-25 11:52:05 +02:00
"studyplanid" => new \external_value(PARAM_INT,
'Study plan id to limit progress search to (to determine which students to scan)', VALUE_DEFAULT),
]);
}
2023-08-27 21:23:39 +02:00
/**
* Parameter description for scan_badge_progress function
*/
2023-08-28 08:51:52 +02:00
public static function scan_badge_progress_returns() : \external_description {
return new \external_single_structure([
"total" => new \external_value(PARAM_INT, 'Total number of students scanned'),
"issued" => new \external_value(PARAM_INT, 'Number of issued badges'),
]);
}
2023-08-27 21:23:39 +02:00
/**
2023-08-27 22:20:17 +02:00
* Scan badge for completion progress statistica
2023-08-27 21:23:39 +02:00
* @param mixed $badgeid ID of the badge
* @param mixed $studyplanid ID of the relevant study plan
* @return array
*/
2023-08-25 10:41:56 +02:00
public static function scan_badge_progress($badgeid, $studyplanid) {
global $DB;
2023-08-24 23:02:41 +02:00
// Check access to the study plan.
2023-08-25 17:33:20 +02:00
$o = studyplan::find_by_id($studyplanid);
2023-08-24 23:02:41 +02:00
webservicehelper::require_capabilities(self::CAP_VIEW, $o->context());
2023-08-24 23:02:41 +02:00
// Validate that badge is linked to studyplan.
if (!$o->badge_linked($badgeid)) {
throw new \webservice_access_exception("Badge {$badgeid} is not linked to studyplan {$o->id()}");
}
2023-08-24 23:02:41 +02:00
// Get badge info.
$badge = new \core_badges\badge($badgeid);
$badgeinfo = new badgeinfo($badge);
2023-08-25 09:44:34 +02:00
// Get the connected users.
$students = associationservice::all_associated($studyplanid);
2023-08-24 23:02:41 +02:00
// Just get the user ids.
2023-08-25 13:04:19 +02:00
$studentids = array_map(function ($a) {
return $a["id"];
}, $students);
return [
"total" => count($studentids),
"issued" => $badgeinfo->count_issued($studentids),
];
}
2023-08-25 11:52:05 +02:00
}