298 lines
11 KiB
PHP
298 lines
11 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Privacy Subsystem implementation for mod_htmlcert.
|
|
*
|
|
* @package mod_htmlcert
|
|
* @copyright 2018 Mark Nelson <markn@moodle.com>, 2021 Klaus-Uwe Mitterer <kumitterer@kumi.systems>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
namespace mod_htmlcert\privacy;
|
|
|
|
use core_privacy\local\metadata\collection;
|
|
use core_privacy\local\request\approved_contextlist;
|
|
use core_privacy\local\request\approved_userlist;
|
|
use core_privacy\local\request\contextlist;
|
|
use core_privacy\local\request\helper;
|
|
use core_privacy\local\request\transform;
|
|
use core_privacy\local\request\userlist;
|
|
use core_privacy\local\request\writer;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Privacy Subsystem implementation for mod_htmlcert.
|
|
*
|
|
* @copyright 2018 Mark Nelson <markn@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class provider implements
|
|
\core_privacy\local\metadata\provider,
|
|
\core_privacy\local\request\plugin\provider,
|
|
\core_privacy\local\request\core_userlist_provider {
|
|
|
|
/**
|
|
* Return the fields which contain personal data.
|
|
*
|
|
* @param collection $items a reference to the collection to use to store the metadata.
|
|
* @return collection the updated collection of metadata items.
|
|
*/
|
|
public static function get_metadata(collection $items) : collection {
|
|
$items->add_database_table(
|
|
'htmlcert_issues',
|
|
[
|
|
'userid' => 'privacy:metadata:htmlcert_issues:userid',
|
|
'htmlcertid' => 'privacy:metadata:htmlcert_issues:htmlcertid',
|
|
'code' => 'privacy:metadata:htmlcert_issues:code',
|
|
'emailed' => 'privacy:metadata:htmlcert_issues:emailed',
|
|
'timecreated' => 'privacy:metadata:htmlcert_issues:timecreated',
|
|
],
|
|
'privacy:metadata:htmlcert_issues'
|
|
);
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Get the list of contexts that contain user information for the specified user.
|
|
*
|
|
* @param int $userid the userid.
|
|
* @return contextlist the list of contexts containing user info for the user.
|
|
*/
|
|
public static function get_contexts_for_userid(int $userid) : contextlist {
|
|
$sql = "SELECT c.id
|
|
FROM {context} c
|
|
INNER JOIN {course_modules} cm
|
|
ON cm.id = c.instanceid
|
|
AND c.contextlevel = :contextlevel
|
|
INNER JOIN {modules} m
|
|
ON m.id = cm.module
|
|
AND m.name = :modulename
|
|
INNER JOIN {htmlcert} htmlcert
|
|
ON htmlcert.id = cm.instance
|
|
INNER JOIN {htmlcert_issues} htmlcertissues
|
|
ON htmlcertissues.htmlcertid = htmlcert.id
|
|
WHERE htmlcertissues.userid = :userid";
|
|
|
|
$params = [
|
|
'modulename' => 'htmlcert',
|
|
'contextlevel' => CONTEXT_MODULE,
|
|
'userid' => $userid,
|
|
];
|
|
$contextlist = new contextlist();
|
|
$contextlist->add_from_sql($sql, $params);
|
|
|
|
return $contextlist;
|
|
}
|
|
|
|
/**
|
|
* Get the list of users who have data within a context.
|
|
*
|
|
* @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
|
|
*/
|
|
public static function get_users_in_context(userlist $userlist) {
|
|
$context = $userlist->get_context();
|
|
|
|
if (!$context instanceof \context_module) {
|
|
return;
|
|
}
|
|
|
|
// Fetch all users who have a custom certificate.
|
|
$sql = "SELECT htmlcertissues.userid
|
|
FROM {course_modules} cm
|
|
JOIN {modules} m
|
|
ON m.id = cm.module AND m.name = :modname
|
|
JOIN {htmlcert} htmlcert
|
|
ON htmlcert.id = cm.instance
|
|
JOIN {htmlcert_issues} htmlcertissues
|
|
ON htmlcertissues.htmlcertid = htmlcert.id
|
|
WHERE cm.id = :cmid";
|
|
|
|
$params = [
|
|
'cmid' => $context->instanceid,
|
|
'modname' => 'htmlcert',
|
|
];
|
|
|
|
$userlist->add_from_sql('userid', $sql, $params);
|
|
}
|
|
|
|
/**
|
|
* Export personal data for the given approved_contextlist. User and context information is contained within the contextlist.
|
|
*
|
|
* @param approved_contextlist $contextlist a list of contexts approved for export.
|
|
*/
|
|
public static function export_user_data(approved_contextlist $contextlist) {
|
|
global $DB;
|
|
|
|
// Filter out any contexts that are not related to modules.
|
|
$cmids = array_reduce($contextlist->get_contexts(), function($carry, $context) {
|
|
if ($context->contextlevel == CONTEXT_MODULE) {
|
|
$carry[] = $context->instanceid;
|
|
}
|
|
return $carry;
|
|
}, []);
|
|
|
|
if (empty($cmids)) {
|
|
return;
|
|
}
|
|
|
|
$user = $contextlist->get_user();
|
|
|
|
// Get all the htmlcert activities associated with the above course modules.
|
|
$htmlcertidstocmids = self::get_htmlcert_ids_to_cmids_from_cmids($cmids);
|
|
|
|
list($insql, $inparams) = $DB->get_in_or_equal(array_keys($htmlcertidstocmids), SQL_PARAMS_NAMED);
|
|
$params = array_merge($inparams, ['userid' => $user->id]);
|
|
$recordset = $DB->get_recordset_select('htmlcert_issues', "htmlcertid $insql AND userid = :userid",
|
|
$params, 'timecreated, id ASC');
|
|
self::recordset_loop_and_export($recordset, 'htmlcertid', [], function($carry, $record) {
|
|
$carry[] = [
|
|
'code' => $record->code,
|
|
'emailed' => transform::yesno($record->emailed),
|
|
'timecreated' => transform::datetime($record->timecreated)
|
|
];
|
|
return $carry;
|
|
}, function($htmlcertid, $data) use ($user, $htmlcertidstocmids) {
|
|
$context = \context_module::instance($htmlcertidstocmids[$htmlcertid]);
|
|
$contextdata = helper::get_context_data($context, $user);
|
|
$finaldata = (object) array_merge((array) $contextdata, ['issues' => $data]);
|
|
helper::export_context_files($context, $user);
|
|
writer::with_context($context)->export_data([], $finaldata);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Delete all data for all users in the specified context.
|
|
*
|
|
* @param \context $context the context to delete in.
|
|
*/
|
|
public static function delete_data_for_all_users_in_context(\context $context) {
|
|
global $DB;
|
|
|
|
if (!$context instanceof \context_module) {
|
|
return;
|
|
}
|
|
|
|
if (!$cm = get_coursemodule_from_id('htmlcert', $context->instanceid)) {
|
|
return;
|
|
}
|
|
|
|
$DB->delete_records('htmlcert_issues', ['htmlcertid' => $cm->instance]);
|
|
}
|
|
|
|
/**
|
|
* Delete all user data for the specified user, in the specified contexts.
|
|
*
|
|
* @param approved_contextlist $contextlist a list of contexts approved for deletion.
|
|
*/
|
|
public static function delete_data_for_user(approved_contextlist $contextlist) {
|
|
global $DB;
|
|
|
|
if (empty($contextlist->count())) {
|
|
return;
|
|
}
|
|
|
|
$userid = $contextlist->get_user()->id;
|
|
foreach ($contextlist->get_contexts() as $context) {
|
|
if (!$context instanceof \context_module) {
|
|
continue;
|
|
}
|
|
$instanceid = $DB->get_field('course_modules', 'instance', ['id' => $context->instanceid], MUST_EXIST);
|
|
$DB->delete_records('htmlcert_issues', ['htmlcertid' => $instanceid, 'userid' => $userid]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete multiple users within a single context.
|
|
*
|
|
* @param approved_userlist $userlist The approved context and user information to delete information for.
|
|
*/
|
|
public static function delete_data_for_users(approved_userlist $userlist) {
|
|
global $DB;
|
|
|
|
$context = $userlist->get_context();
|
|
if (!$context instanceof \context_module) {
|
|
return;
|
|
}
|
|
|
|
$cm = get_coursemodule_from_id('htmlcert', $context->instanceid);
|
|
if (!$cm) {
|
|
// Only htmlcert module will be handled.
|
|
return;
|
|
}
|
|
|
|
$userids = $userlist->get_userids();
|
|
list($usersql, $userparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
|
|
|
|
$select = "htmlcertid = :htmlcertid AND userid $usersql";
|
|
$params = ['htmlcertid' => $cm->instance] + $userparams;
|
|
$DB->delete_records_select('htmlcert_issues', $select, $params);
|
|
}
|
|
|
|
/**
|
|
* Return a list of htmlcert IDs mapped to their course module ID.
|
|
*
|
|
* @param array $cmids The course module IDs.
|
|
* @return array In the form of [$htmlcertid => $cmid].
|
|
*/
|
|
protected static function get_htmlcert_ids_to_cmids_from_cmids(array $cmids) {
|
|
global $DB;
|
|
|
|
list($insql, $inparams) = $DB->get_in_or_equal($cmids, SQL_PARAMS_NAMED);
|
|
$sql = "SELECT htmlcert.id, cm.id AS cmid
|
|
FROM {htmlcert} htmlcert
|
|
JOIN {modules} m
|
|
ON m.name = :modulename
|
|
JOIN {course_modules} cm
|
|
ON cm.instance = htmlcert.id
|
|
AND cm.module = m.id
|
|
WHERE cm.id $insql";
|
|
$params = array_merge($inparams, ['modulename' => 'htmlcert']);
|
|
|
|
return $DB->get_records_sql_menu($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* Loop and export from a recordset.
|
|
*
|
|
* @param \moodle_recordset $recordset The recordset.
|
|
* @param string $splitkey The record key to determine when to export.
|
|
* @param mixed $initial The initial data to reduce from.
|
|
* @param callable $reducer The function to return the dataset, receives current dataset, and the current record.
|
|
* @param callable $export The function to export the dataset, receives the last value from $splitkey and the dataset.
|
|
* @return void
|
|
*/
|
|
protected static function recordset_loop_and_export(\moodle_recordset $recordset, $splitkey, $initial,
|
|
callable $reducer, callable $export) {
|
|
$data = $initial;
|
|
$lastid = null;
|
|
|
|
foreach ($recordset as $record) {
|
|
if ($lastid && $record->{$splitkey} != $lastid) {
|
|
$export($lastid, $data);
|
|
$data = $initial;
|
|
}
|
|
$data = $reducer($data, $record);
|
|
$lastid = $record->{$splitkey};
|
|
}
|
|
$recordset->close();
|
|
|
|
if (!empty($lastid)) {
|
|
$export($lastid, $data);
|
|
}
|
|
}
|
|
}
|