Skip to content

Commit

Permalink
MDL-62007 profilefield_datetime: Add privacy files and unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Mihail Geshoski committed May 3, 2018
1 parent 446d848 commit 76b61aa
Show file tree
Hide file tree
Showing 3 changed files with 388 additions and 0 deletions.
174 changes: 174 additions & 0 deletions user/profile/field/datetime/classes/privacy/provider.php
View file
@@ -0,0 +1,174 @@
<?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 class for requesting user data.
*
* @package profilefield_datetime
* @copyright 2018 Mihail Geshoski <mihail@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace profilefield_datetime\privacy;

defined('MOODLE_INTERNAL') || die();

use \core_privacy\local\metadata\collection;
use \core_privacy\local\request\contextlist;
use \core_privacy\local\request\approved_contextlist;
use \core_privacy\local\request\transform;

/**
* Privacy class for requesting user data.
*
* @copyright 2018 Mihail Geshoski <mihail@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 {

/**
* Returns meta data about this system.
*
* @param collection $collection The initialised collection to add items to.
* @return collection A listing of user data stored through this system.
*/
public static function get_metadata(collection $collection) : collection {
return $collection->add_database_table('user_info_data', [
'userid' => 'privacy:metadata:profilefield_datetime:userid',
'fieldid' => 'privacy:metadata:profilefield_datetime:fieldid',
'data' => 'privacy:metadata:profilefield_datetime:data',
'dataformat' => 'privacy:metadata:profilefield_datetime:dataformat'
], 'privacy:metadata:profilefield_datetime:tableexplanation');
}

/**
* Get the list of contexts that contain user information for the specified user.
*
* @param int $userid The user to search.
* @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
*/
public static function get_contexts_for_userid(int $userid) : contextlist {
$sql = "SELECT ctx.id
FROM {user_info_data} uda
JOIN {user_info_field} uif ON uda.fieldid = uif.id
JOIN {context} ctx ON ctx.instanceid = uda.userid
AND ctx.contextlevel = :contextlevel
WHERE uda.userid = :userid
AND uif.datatype = :datatype";
$params = [
'userid' => $userid,
'contextlevel' => CONTEXT_USER,
'datatype' => 'datetime'
];
$contextlist = new contextlist();
$contextlist->add_from_sql($sql, $params);

return $contextlist;
}

/**
* Export all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts to export information for.
*/
public static function export_user_data(approved_contextlist $contextlist) {
$user = $contextlist->get_user();
foreach ($contextlist->get_contexts() as $context) {
// Check if the context is a user context.
if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
$results = static::get_records($user->id);
foreach ($results as $result) {
$data = (object) [
'name' => $result->name,
'description' => $result->description,
'data' => transform::date($result->data)
];
\core_privacy\local\request\writer::with_context($context)->export_data([
get_string('pluginname', 'profilefield_datetime')], $data);
}
}
}
}

/**
* Delete all user data which matches the specified context.
*
* @param context $context A user context.
*/
public static function delete_data_for_all_users_in_context(\context $context) {
// Delete data only for user context.
if ($context->contextlevel == CONTEXT_USER) {
static::delete_data($context->instanceid);
}
}

/**
* Delete all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
*/
public static function delete_data_for_user(approved_contextlist $contextlist) {
$user = $contextlist->get_user();
foreach ($contextlist->get_contexts() as $context) {
// Check if the context is a user context.
if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
static::delete_data($context->instanceid);
}
}
}

/**
* Delete data related to a userid.
*
* @param int $userid The user ID
*/
protected static function delete_data($userid) {
global $DB;

$params = [
'userid' => $userid,
'datatype' => 'datetime'
];

$DB->delete_records_select('user_info_data', "fieldid IN (
SELECT id FROM {user_info_field} WHERE datatype = :datatype)
AND userid = :userid", $params);
}

/**
* Get records related to this plugin and user.
*
* @param int $userid The user ID
* @return array An array of records.
*/
protected static function get_records($userid) {
global $DB;

$sql = "SELECT *
FROM {user_info_data} uda
JOIN {user_info_field} uif ON uda.fieldid = uif.id
WHERE uda.userid = :userid
AND uif.datatype = :datatype";
$params = [
'userid' => $userid,
'datatype' => 'datetime'
];

return $DB->get_records_sql($sql, $params);
}
}
5 changes: 5 additions & 0 deletions user/profile/field/datetime/lang/en/profilefield_datetime.php
View file
Expand Up @@ -27,6 +27,11 @@
$string['endyear'] = 'End year';
$string['notset'] = 'Not set';
$string['pluginname'] = 'Date/Time';
$string['privacy:metadata:profilefield_datetime:userid'] = 'The ID of the user which data is stored by the Date/Time plugin.';
$string['privacy:metadata:profilefield_datetime:fieldid'] = 'The ID of the profile field.';
$string['privacy:metadata:profilefield_datetime:data'] = 'The stored user data.';
$string['privacy:metadata:profilefield_datetime:dataformat'] = 'The format of the stored user data.';
$string['privacy:metadata:profilefield_datetime:tableexplanation'] = 'Additional user information is stored here.';
$string['specifydatedefault'] = 'or specify a date';
$string['startyearafterend'] = 'The start year can\'t occur after the end year';
$string['startyear'] = 'Start year';
Expand Down
209 changes: 209 additions & 0 deletions user/profile/field/datetime/tests/privacy_test.php
View file
@@ -0,0 +1,209 @@
<?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/>.

/**
* Base class for unit tests for profilefield_datetime.
*
* @package profilefield_datetime
* @copyright 2018 Mihail Geshoski <mihail@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

defined('MOODLE_INTERNAL') || die();

use \core_privacy\tests\provider_testcase;

/**
* Unit tests for user\profile\field\datetime\classes\privacy\provider.php
*
* @copyright 2018 Mihail Geshoski <mihail@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class profilefield_datetime_testcase extends provider_testcase {

/**
* Basic setup for these tests.
*/
public function setUp() {
$this->resetAfterTest(true);
}

/**
* Test getting the context for the user ID related to this plugin.
*/
public function test_get_contexts_for_userid() {
global $DB;
// Create profile category.
$categoryid = $this->add_profile_category();
// Create profile field.
$profilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$this->add_user_info_data($user->id, $profilefieldid, 'test data');
// Get the field that was created.
$userfielddata = $DB->get_records('user_info_data', array('userid' => $user->id));
// Confirm we got the right number of user field data.
$this->assertCount(1, $userfielddata);
$context = context_user::instance($user->id);
$contextlist = \profilefield_datetime\privacy\provider::get_contexts_for_userid($user->id);
$this->assertEquals($context, $contextlist->current());
}

/**
* Test that data is exported correctly for this plugin.
*/
public function test_export_user_data() {
// Create profile category.
$categoryid = $this->add_profile_category();
// Create datetime profile field.
$datetimeprofilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create checkbox profile field.
$checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$context = context_user::instance($user->id);
// Add datetime user info data.
$this->add_user_info_data($user->id, $datetimeprofilefieldid, '1524067200');
// Add checkbox user info data.
$this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');

$writer = \core_privacy\local\request\writer::with_context($context);
$this->assertFalse($writer->has_any_data());
$this->export_context_data_for_user($user->id, $context, 'profilefield_datetime');
$data = $writer->get_data([get_string('pluginname', 'profilefield_datetime')]);
$this->assertCount(3, (array) $data);
$this->assertEquals('Test field', $data->name);
$this->assertEquals('This is a test.', $data->description);
$this->assertEquals('19 April 2018', $data->data);
}

/**
* Test that user data is deleted using the context.
*/
public function test_delete_data_for_all_users_in_context() {
global $DB;
// Create profile category.
$categoryid = $this->add_profile_category();
// Create datetime profile field.
$datetimeprofilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create checkbox profile field.
$checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$context = context_user::instance($user->id);
// Add datetime user info data.
$this->add_user_info_data($user->id, $datetimeprofilefieldid, '1524067200');
// Add checkbox user info data.
$this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
// Check that we have two entries.
$userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
$this->assertCount(2, $userinfodata);
\profilefield_datetime\privacy\provider::delete_data_for_all_users_in_context($context);
// Check that the correct profile field has been deleted.
$userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
$this->assertCount(1, $userinfodata);
$this->assertNotEquals('1524067200', reset($userinfodata)->data);
}

/**
* Test that user data is deleted for this user.
*/
public function test_delete_data_for_user() {
global $DB;
// Create profile category.
$categoryid = $this->add_profile_category();
// Create datetime profile field.
$datetimeprofilefieldid = $this->add_profile_field($categoryid, 'datetime');
// Create checkbox profile field.
$checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
// Create a user.
$user = $this->getDataGenerator()->create_user();
$context = context_user::instance($user->id);
// Add datetime user info data.
$this->add_user_info_data($user->id, $datetimeprofilefieldid, '1524067200');
// Add checkbox user info data.
$this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
// Check that we have two entries.
$userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
$this->assertCount(2, $userinfodata);
$approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_datetime',
[$context->id]);
\profilefield_datetime\privacy\provider::delete_data_for_user($approvedlist);
// Check that the correct profile field has been deleted.
$userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
$this->assertCount(1, $userinfodata);
$this->assertNotEquals('1524067200', reset($userinfodata)->data);
}

/**
* Add dummy user info data.
*
* @param int $userid The ID of the user
* @param int $fieldid The ID of the field
* @param string $data The data
*/
private function add_user_info_data($userid, $fieldid, $data) {
global $DB;
$userinfodata = array(
'userid' => $userid,
'fieldid' => $fieldid,
'data' => $data,
'dataformat' => 0
);

$DB->insert_record('user_info_data', $userinfodata);
}

/**
* Add dummy profile category.
*
* @return int The ID of the profile category
*/
private function add_profile_category() {
global $DB;
// Create a new profile category.
$cat = new stdClass();
$cat->name = 'Test category';
$cat->sortorder = 1;

return $DB->insert_record('user_info_category', $cat);
}

/**
* Add dummy profile field.
*
* @param int $categoryid The ID of the profile category
* @param string $datatype The datatype of the profile field
* @return int The ID of the profile field
*/
private function add_profile_field($categoryid, $datatype) {
global $DB;
// Create a new profile field.
$data = new stdClass();
$data->datatype = $datatype;
$data->shortname = 'tstField';
$data->name = 'Test field';
$data->description = 'This is a test.';
$data->required = false;
$data->locked = false;
$data->forceunique = false;
$data->signup = false;
$data->visible = '0';
$data->categoryid = $categoryid;

return $DB->insert_record('user_info_field', $data);
}
}

0 comments on commit 76b61aa

Please sign in to comment.