Privacy API это набор интерфейсов Moodle, с помощью которых каждый плагин сообщает системе: какие персональные данные он хранит, как их выгрузить по запросу человека и как удалить. Без него администратор, получив обращение субъекта данных, не может ни собрать всё, что хранится о человеке, ни быть уверен, что удалил всё. Для плагина, который работает с реальными студентами, это не формальность. В моих плагинах (зачётная книжка, личный кабинет слушателя, отчёты) данные людей составляют основное содержимое, и провайдер у них пишется вместе с первой таблицей, а не перед релизом. Базовая структура плагина описана в статье про файлы плагина.
Зачем он нужен и при чём тут 152-ФЗ
Закон о персональных данных даёт человеку права: узнать, какие данные о нём обрабатываются, потребовать уточнения, прекращения обработки и уничтожения. Организация-оператор обязана отвечать. Если данные разбросаны по десятку плагинов и таблиц, ответить нечем без ручного поиска по базе. Privacy API превращает поиск в стандартную процедуру: администратор открывает инструмент «Запросы на данные» («Администрирование → Пользователи → Конфиденциальность и политики»), создаёт запрос, а ядро обходит провайдеры всех плагинов.
Нужно сразу разграничить. Технически API не делает сайт «соответствующим закону». Он закрывает один вопрос: как найти и вынести данные пользователя из плагина. Согласия, политика обработки, уведомление о начале обработки, место хранения баз и меры защиты лежат на организации. Эту часть я разбирала в материале про Moodle и 152-ФЗ.
Три вида провайдеров
Класс провайдера лежит в classes/privacy/provider.php и называется строго provider в пространстве имён компонент\privacy. Какие интерфейсы реализовать, зависит от плагина:
| Ситуация | Что реализовать |
|---|---|
| Плагин не хранит данных о пользователях | \core_privacy\local\metadata\null_provider и метод get_reason() |
| Плагин только описывает данные, которые передаёт в подсистемы ядра (например, в сообщения) | \core_privacy\local\metadata\provider с методом get_metadata() |
| Плагин хранит данные о пользователях сам | metadata\provider, \core_privacy\local\request\plugin\provider, а также \core_privacy\local\request\core_userlist_provider |
Самый простой случай выглядит так:
<?php
namespace local_hello\privacy;
defined('MOODLE_INTERNAL') || die();
class provider implements \core_privacy\local\metadata\null_provider {
public static function get_reason(): string {
return 'privacy:metadata';
}
}
Метод возвращает ключ строки языка из lang/en/local_hello.php, например $string['privacy:metadata'] = 'The Hello plugin does not store personal data.';. Это тот самый ключ, который добавлялся в языковой файл ещё в пошаговом руководстве.
Описание данных: get_metadata
Если плагин хранит данные, метод get_metadata() перечисляет, что именно, и привязывает каждое поле к строке языка.
use core_privacy\local\metadata\collection;
public static function get_metadata(collection $collection): collection {
$collection->add_database_table('local_hello_note', [
'userid' => 'privacy:metadata:note:userid',
'notetext' => 'privacy:metadata:note:notetext',
'timecreated' => 'privacy:metadata:note:timecreated',
], 'privacy:metadata:note');
$collection->add_external_location_link('crm', [
'fullname' => 'privacy:metadata:crm:fullname',
'email' => 'privacy:metadata:crm:email',
], 'privacy:metadata:crm');
return $collection;
}
Здесь описаны таблица плагина и передача данных во внешнюю систему. Каждый ключ в массиве (privacy:metadata:note:userid и так далее) должен существовать в языковом файле: именно эти фразы увидит администратор и субъект данных. Для настроек пользователя есть add_user_preference(), а для данных, которые уходят в подсистемы ядра, add_subsystem_link(). Передачу данных вовне особенно важно описать честно: если плагин отправляет имя и почту в CRM, мессенджер или платёжный сервис, в метаданных это должно быть видно.
Методы провайдера, который хранит данные
| Метод | Что делает |
|---|---|
get_metadata() | Описывает типы хранимых данных |
get_contexts_for_userid(int $userid) | Возвращает список контекстов, где есть данные пользователя |
get_users_in_context(userlist $userlist) | Добавляет в список всех пользователей, чьи данные есть в контексте |
export_user_data(approved_contextlist $contextlist) | Выгружает данные пользователя в переданных контекстах |
delete_data_for_all_users_in_context(\context $context) | Удаляет данные всех пользователей в контексте |
delete_data_for_user(approved_contextlist $contextlist) | Удаляет данные одного пользователя в контекстах |
delete_data_for_users(approved_userlist $userlist) | Удаляет данные группы пользователей в одном контексте |
Контекст здесь центральное понятие: провайдер отвечает на вопрос «в каких местах Moodle у человека есть мои данные». Для local-плагина с общесистемными таблицами это системный контекст; для данных, привязанных к курсу, контекст курса.
Поиск контекстов и экспорт
Для системного плагина поиск контекстов сводится к проверке, есть ли у пользователя записи:
use core_privacy\local\request\contextlist;
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\writer;
public static function get_contexts_for_userid(int $userid): contextlist {
$contextlist = new contextlist();
$sql = "SELECT ctx.id
FROM {context} ctx
WHERE ctx.contextlevel = :level
AND EXISTS (SELECT 1 FROM {local_hello_note} n WHERE n.userid = :userid)";
$contextlist->add_from_sql($sql, [
'level' => CONTEXT_SYSTEM,
'userid' => $userid,
]);
return $contextlist;
}
public static function export_user_data(approved_contextlist $contextlist) {
global $DB;
$userid = $contextlist->get_user()->id;
$notes = $DB->get_records('local_hello_note', ['userid' => $userid]);
$data = [];
foreach ($notes as $note) {
$data[] = (object) [
'text' => $note->notetext,
'created' => \core_privacy\local\request\transform::datetime($note->timecreated),
];
}
writer::with_context(\context_system::instance())
->export_data([get_string('pluginname', 'local_hello')], (object) ['notes' => $data]);
}
Запрос использует плейсхолдеры, названия таблиц заключены в фигурные скобки, префикс подставится сам. Метод export_data() принимает путь (массив названий подразделов) и данные. Даты преобразуют вспомогательным методом transform::datetime(), чтобы в выгрузке они были читаемыми. Файлы пользователя выгружают отдельным вызовом писателя.
Удаление
Удаление должно быть точным: нельзя удалять данные других пользователей, и нельзя оставлять данные запрошенного. Обратите внимание, что ядро вызывает метод удаления для всех пользователей в контексте, например при удалении курса, и для одного пользователя в списке контекстов:
public static function delete_data_for_user(approved_contextlist $contextlist) {
global $DB;
if (empty($contextlist->count())) {
return;
}
$DB->delete_records('local_hello_note',
['userid' => $contextlist->get_user()->id]);
}
Если данные нельзя физически удалить (например, финансовый документ, который по закону хранится определённый срок), в провайдере его анонимизируют: обнуляют идентифицирующие поля и сохраняют запись. Решение о том, что удалять, а что хранить, принимает организация; код его реализует. Мне как разработчику здесь важно задать вопрос заказчику до начала работ: какие записи подлежат хранению и сколько. Обсуждение таких вопросов входит в постановку задачи для разработки плагина.
Типичные пропуски
| Что упущено | Последствие |
|---|---|
| Провайдера нет вообще | Плагин считается несовместимым с Privacy API, данные невозможно экспортировать и удалить стандартным путём |
| Не описаны внешние получатели данных | Субъект и администратор не знают, куда уходят данные |
| Нет строк языка для метаданных | В интерфейсе видны технические коды, проверка кода выдаёт ошибки |
| Реализован экспорт, но не удаление | Запрос на уничтожение данных выполнить невозможно |
| Удаление по неверному контексту | Данные остаются при удалении курса или пользователя |
| Новая таблица добавлена, провайдер не обновлён | Часть данных выпала из выгрузки |
Где ещё лежат данные пользователя
При описании данных плагина легко ограничиться таблицами, но персональные данные оседают и в других местах. Перед тем как объявить провайдер готовым, пройдите по списку:
| Место | Пример | Как описать |
|---|---|---|
| Таблицы плагина | Записи с идентификатором пользователя | add_database_table() |
| Файлы | Загруженные документы | Выгружаются отдельным вызовом писателя, описываются как файловая область |
| Предпочтения пользователя | Выбранный фильтр или режим | add_user_preference() и экспорт предпочтений |
| Внешние сервисы | CRM, мессенджер, платёжная система | add_external_location_link() |
| Подсистемы ядра | Сообщения, оценки, комментарии | add_subsystem_link() |
| Журналы и события | Записи о действиях | Если плагин пишет собственные журналы, их нужно описать так же, как таблицы |
| Кэш и временные файлы | Данные сессии, выгрузки в каталоге временных файлов | Не хранить дольше необходимого, очищать задачей |
Отдельный случай: отчёты, которые генерируют PDF и Excel с данными студентов. Файл-выгрузка это копия персональных данных, и если плагин оставляет такие файлы на диске, их нужно либо удалять сразу после отдачи, либо описывать и чистить по расписанию. Я закладываю очистку в плановую задачу и описываю это в метаданных.
Предпочтения пользователя
Если плагин запоминает настройки пользователя (например, выбранный период в отчёте), реализуется ещё один интерфейс, \core_privacy\local\request\user_preference_provider, и метод export_user_preferences(). Внутри вы получаете значения через get_user_preferences() и отдаёте писателю вызовом export_user_preference() с человекочитаемым описанием. Мелочь, но без неё в выгрузке чего-то будет не хватать.
Анонимизация и сроки хранения
Удалить запись физически не всегда можно. Например, если по ней сформирован документ об обучении, организация обязана хранить его в течение установленного срока. Тогда запрос на удаление выполняют так: данные, которые позволяют установить человека, обезличивают, а запись остаётся. В коде провайдера это update_record вместо delete_records: поле с именем очищают, идентификатор пользователя заменяют нулём или служебным значением. Решение, что хранить и сколько, принимает организация с юристом; программист не вправе принимать его сам, но обязан спросить об этом до начала работ. Это один из пунктов, которые я включаю в постановку задачи; примеры формулировок есть в материале про техническое задание на плагин.
Сроки хранения можно закрепить и технически: плановая задача удаляет устаревшие записи по настройке «срок хранения в днях». Тогда политика организации записана не только в документе, но и работает в системе. Подробнее о плановых задачах будет в одной из следующих статей серии.
Что показать заказчику
Когда плагин сдаётся, я показываю заказчику три вещи: страницу «Плагины → Конфиденциальность» со списком реализованных провайдеров, пробный запрос на экспорт данных тестового пользователя и пробный запрос на удаление. Это наглядно: видно, что именно выгружается, и что после удаления в таблицах не осталось его записей. Такой акт проверки можно приложить к документам по приёмке. Чек-лист приёмки внедрения, которым я пользуюсь, есть в статье про приёмку работ подрядчика.
Как проверить провайдер
Ядро содержит тестовый базовый класс для провайдеров. Он создаёт пользователей, контексты и позволяет выполнить цепочку: найти контексты, экспортировать, удалить, убедиться, что осталось только чужое. Эти тесты я пишу вместе с первой версией плагина. Кроме того, проверьте руками на тестовом сайте: создайте данные, оформите запрос на экспорт и на удаление в инструменте «Запросы на данные» и посмотрите результат. Подробнее про тесты будет в одной из статей следующей партии.
Чек-лист: у каждой таблицы с идентификатором пользователя есть описание в метаданных; экспорт возвращает все записи; удаление не трогает чужие; внешние передачи описаны; все ключи строк существуют. Если у вас есть плагин, который хранит данные студентов и не имеет провайдера, это можно исправить в рамках доработки Moodle, а при аудите системы этот пункт входит в мой список проверки.
Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.