Proyectos de Subversion Moodle

<?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/>.

namespace core_user\privacy;

use core\tests\session\mock_handler;

use core_privacy\tests\provider_testcase;

use core_privacy\local\request\approved_userlist;

use core_privacy\local\request\transform;

use core_user\privacy\provider;

/**

 * Unit tests for core_user.

 *

 * @package core_user

 * @copyright  2018 Adrian Greeve <adrian@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 * @covers \core_user\privacy\provider

 */

final class provider_test extends provider_testcase {

    public static function setUpBeforeClass(): void {

        global $CFG;

        parent::setUpBeforeClass();

        require_once($CFG->dirroot . "/user/lib.php");

    }

    /**

     * Check that context information is returned correctly.

     */

    public function test_get_contexts_for_userid(): void {

        $this->resetAfterTest();

        $user = $this->getDataGenerator()->create_user();

        // Create some other users as well.

        $user2 = $this->getDataGenerator()->create_user();

        $user3 = $this->getDataGenerator()->create_user();

        $context = \context_user::instance($user->id);

        $contextlist = provider::get_contexts_for_userid($user->id);

        $this->assertSame($context, $contextlist->current());

    }

    /**

     * Test that data is exported as expected for a user.

     */

    public function test_export_user_data(): void {

        $this->resetAfterTest();

        $user = $this->getDataGenerator()->create_user([

            'firstaccess' => 1535760000,

            'lastaccess' => 1541030400,

            'currentlogin' => 1541030400,

        ]);

        $course = $this->getDataGenerator()->create_course();

        $context = \context_user::instance($user->id);

        $this->create_data_for_user($user, $course);

        $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'core_user', [$context->id]);

        $writer = \core_privacy\local\request\writer::with_context($context);

        provider::export_user_data($approvedlist);

        // Make sure that the password history only returns a count.

        $history = $writer->get_data([get_string('privacy:passwordhistorypath', 'user')]);

        $objectcount = new \ArrayObject($history);

        // This object should only have one property.

        $this->assertCount(1, $objectcount);

        $this->assertEquals(1, $history->password_history_count);

        // Password resets should have two fields - timerequested and timererequested.

        $resetarray = (array) $writer->get_data([get_string('privacy:passwordresetpath', 'user')]);

        $detail = array_shift($resetarray);

        $this->assertTrue(array_key_exists('timerequested', $detail));

        $this->assertTrue(array_key_exists('timererequested', $detail));

        // Last access to course.

        $lastcourseaccess = (array) $writer->get_data([get_string('privacy:lastaccesspath', 'user')]);

        $entry = array_shift($lastcourseaccess);

        $this->assertEquals($course->fullname, $entry['course_name']);

        $this->assertTrue(array_key_exists('timeaccess', $entry));

        // User devices.

        $userdevices = (array) $writer->get_data([get_string('privacy:devicespath', 'user')]);

        $entry = array_shift($userdevices);

        $this->assertEquals('com.moodle.moodlemobile', $entry['appid']);

        // Make sure these fields are not exported.

        $this->assertFalse(array_key_exists('pushid', $entry));

        $this->assertFalse(array_key_exists('uuid', $entry));

        // Session data.

        $sessiondata = (array) $writer->get_data([get_string('privacy:sessionpath', 'user')]);

        $entry = array_shift($sessiondata);

        // Make sure that the sid is not exported.

        $this->assertFalse(array_key_exists('sid', $entry));

        // Check that some of the other fields are present.

        $this->assertTrue(array_key_exists('state', $entry));

        $this->assertTrue(array_key_exists('sessdata', $entry));

        $this->assertTrue(array_key_exists('timecreated', $entry));

        // Course requests

        $courserequestdata = (array) $writer->get_data([get_string('privacy:courserequestpath', 'user')]);

        $entry = array_shift($courserequestdata);

        // Make sure that the password is not exported.

        $this->assertFalse(property_exists($entry, 'password'));

        // Check that some of the other fields are present.

        $this->assertTrue(property_exists($entry, 'fullname'));

        $this->assertTrue(property_exists($entry, 'shortname'));

        $this->assertTrue(property_exists($entry, 'summary'));

         // User details.

        $userdata = (array) $writer->get_data([]);

        // Check that the password is not exported.

        $this->assertFalse(array_key_exists('password', $userdata));

        // Check that some critical fields exist.

        $this->assertTrue(array_key_exists('firstname', $userdata));

        $this->assertTrue(array_key_exists('lastname', $userdata));

        $this->assertTrue(array_key_exists('email', $userdata));

        // Check access times.

        $this->assertEquals(transform::datetime($user->firstaccess), $userdata['firstaccess']);

        $this->assertEquals(transform::datetime($user->lastaccess), $userdata['lastaccess']);

        $this->assertNull($userdata['lastlogin']);

        $this->assertEquals(transform::datetime($user->currentlogin), $userdata['currentlogin']);

    }

    /**

     * Test that user data is deleted for one user.

     */

    public function test_delete_data_for_all_users_in_context(): void {

        global $DB;

        $this->resetAfterTest();

        $user = $this->getDataGenerator()->create_user([

            'idnumber' => 'A0023',

            'emailstop' => 1,

            'phone1' => '555 3257',

            'institution' => 'test',

            'department' => 'Science',

            'city' => 'Perth',

            'country' => 'AU'

        ]);

        $user2 = $this->getDataGenerator()->create_user();

        $course = $this->getDataGenerator()->create_course();

        $this->create_data_for_user($user, $course);

        $this->create_data_for_user($user2, $course);

        provider::delete_data_for_all_users_in_context(\context_user::instance($user->id));

        // These tables should not have any user data for $user. Only for $user2.

        $records = $DB->get_records('user_password_history');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        $records = $DB->get_records('user_password_resets');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        $records = $DB->get_records('user_lastaccess');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        $records = $DB->get_records('user_devices');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        // Now check that there is still a record for the deleted user, but that non-critical information is removed.

        $record = $DB->get_record('user', ['id' => $user->id]);

        $this->assertEmpty($record->idnumber);

        $this->assertEmpty($record->emailstop);

        $this->assertEmpty($record->phone1);

        $this->assertEmpty($record->institution);

        $this->assertEmpty($record->department);

        $this->assertEmpty($record->city);

        $this->assertEmpty($record->country);

        $this->assertEmpty($record->timezone);

        $this->assertEmpty($record->timecreated);

        $this->assertEmpty($record->timemodified);

        $this->assertEmpty($record->firstnamephonetic);

        // Check for critical fields.

        // Deleted should now be 1.

        $this->assertEquals(1, $record->deleted);

        $this->assertEquals($user->id, $record->id);

        $this->assertEquals($user->username, $record->username);

        $this->assertEquals($user->password, $record->password);

        $this->assertEquals($user->firstname, $record->firstname);

        $this->assertEquals($user->lastname, $record->lastname);

        $this->assertEquals($user->email, $record->email);

    }

    /**

     * Test that user data is deleted for one user.

     */

    public function test_delete_data_for_user(): void {

        global $DB;

        $this->resetAfterTest();

        $user = $this->getDataGenerator()->create_user([

            'idnumber' => 'A0023',

            'emailstop' => 1,

            'phone1' => '555 3257',

            'institution' => 'test',

            'department' => 'Science',

            'city' => 'Perth',

            'country' => 'AU'

        ]);

        $user2 = $this->getDataGenerator()->create_user();

        $course = $this->getDataGenerator()->create_course();

        $this->create_data_for_user($user, $course);

        $this->create_data_for_user($user2, $course);

        // Provide multiple different context to check that only the correct user is deleted.

        $contexts = [

            \context_user::instance($user->id)->id,

            \context_user::instance($user2->id)->id,

            \context_system::instance()->id];

        $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'core_user', $contexts);

        provider::delete_data_for_user($approvedlist);

        // These tables should not have any user data for $user. Only for $user2.

        $records = $DB->get_records('user_password_history');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        $records = $DB->get_records('user_password_resets');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        $records = $DB->get_records('user_lastaccess');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        $records = $DB->get_records('user_devices');

        $this->assertCount(1, $records);

        $data = array_shift($records);

        $this->assertNotEquals($user->id, $data->userid);

        $this->assertEquals($user2->id, $data->userid);

        // Now check that there is still a record for the deleted user, but that non-critical information is removed.

        $record = $DB->get_record('user', ['id' => $user->id]);

        $this->assertEmpty($record->idnumber);

        $this->assertEmpty($record->emailstop);

        $this->assertEmpty($record->phone1);

        $this->assertEmpty($record->institution);

        $this->assertEmpty($record->department);

        $this->assertEmpty($record->city);

        $this->assertEmpty($record->country);

        $this->assertEmpty($record->timezone);

        $this->assertEmpty($record->timecreated);

        $this->assertEmpty($record->timemodified);

        $this->assertEmpty($record->firstnamephonetic);

        // Check for critical fields.

        // Deleted should now be 1.

        $this->assertEquals(1, $record->deleted);

        $this->assertEquals($user->id, $record->id);

        $this->assertEquals($user->username, $record->username);

        $this->assertEquals($user->password, $record->password);

        $this->assertEquals($user->firstname, $record->firstname);

        $this->assertEquals($user->lastname, $record->lastname);

        $this->assertEquals($user->email, $record->email);

    }

    /**

     * Test that only users with a user context are fetched.

     */

    public function test_get_users_in_context(): void {

        $this->resetAfterTest();

        $component = 'core_user';

        // Create a user.

        $user = $this->getDataGenerator()->create_user();

        $usercontext = \context_user::instance($user->id);

        $userlist = new \core_privacy\local\request\userlist($usercontext, $component);

        // The list of users for user context should return the user.

        provider::get_users_in_context($userlist);

        $this->assertCount(1, $userlist);

        $expected = [$user->id];

        $actual = $userlist->get_userids();

        $this->assertEquals($expected, $actual);

        // The list of users for system context should not return any users.

        $systemcontext = \context_system::instance();

        $userlist = new \core_privacy\local\request\userlist($systemcontext, $component);

        provider::get_users_in_context($userlist);

        $this->assertCount(0, $userlist);

    }

    /**

     * Test that data for users in approved userlist is deleted.

     */

    public function test_delete_data_for_users(): void {

        global $DB;

        $this->resetAfterTest();

        $component = 'core_user';

        // Create user1.

        $user1 = $this->getDataGenerator()->create_user([

            'idnumber' => 'A0023',

            'emailstop' => 1,

            'phone1' => '555 3257',

            'institution' => 'test',

            'department' => 'Science',

            'city' => 'Perth',

            'country' => 'AU'

        ]);

        $usercontext1 = \context_user::instance($user1->id);

        $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);

        // Create user2.

        $user2 = $this->getDataGenerator()->create_user([

            'idnumber' => 'A0024',

            'emailstop' => 1,

            'phone1' => '555 3258',

            'institution' => 'test',

            'department' => 'Science',

            'city' => 'Perth',

            'country' => 'AU'

        ]);

        $usercontext2 = \context_user::instance($user2->id);

        $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);

        // The list of users for usercontext1 should return user1.

        provider::get_users_in_context($userlist1);

        $this->assertCount(1, $userlist1);

        // The list of users for usercontext2 should return user2.

        provider::get_users_in_context($userlist2);

        $this->assertCount(1, $userlist2);

        // Add userlist1 to the approved user list.

        $approvedlist = new approved_userlist($usercontext1, $component, $userlist1->get_userids());

        // Delete using delete_data_for_users().

        provider::delete_data_for_users($approvedlist);

        // Now check that there is still a record for user1 (deleted user), but non-critical information is removed.

        $record = $DB->get_record('user', ['id' => $user1->id]);

        $this->assertEmpty($record->idnumber);

        $this->assertEmpty($record->emailstop);

        $this->assertEmpty($record->phone1);

        $this->assertEmpty($record->institution);

        $this->assertEmpty($record->department);

        $this->assertEmpty($record->city);

        $this->assertEmpty($record->country);

        $this->assertEmpty($record->timezone);

        $this->assertEmpty($record->timecreated);

        $this->assertEmpty($record->timemodified);

        $this->assertEmpty($record->firstnamephonetic);

        // Check for critical fields.

        // Deleted should now be 1.

        $this->assertEquals(1, $record->deleted);

        $this->assertEquals($user1->id, $record->id);

        $this->assertEquals($user1->username, $record->username);

        $this->assertEquals($user1->password, $record->password);

        $this->assertEquals($user1->firstname, $record->firstname);

        $this->assertEquals($user1->lastname, $record->lastname);

        $this->assertEquals($user1->email, $record->email);

        // Now check that the record and information for user2 is still present.

        $record = $DB->get_record('user', ['id' => $user2->id]);

        $this->assertNotEmpty($record->idnumber);

        $this->assertNotEmpty($record->emailstop);

        $this->assertNotEmpty($record->phone1);

        $this->assertNotEmpty($record->institution);

        $this->assertNotEmpty($record->department);

        $this->assertNotEmpty($record->city);

        $this->assertNotEmpty($record->country);

        $this->assertNotEmpty($record->timezone);

        $this->assertNotEmpty($record->timecreated);

        $this->assertNotEmpty($record->timemodified);

        $this->assertNotEmpty($record->firstnamephonetic);

        $this->assertEquals(0, $record->deleted);

        $this->assertEquals($user2->id, $record->id);

        $this->assertEquals($user2->username, $record->username);

        $this->assertEquals($user2->password, $record->password);

        $this->assertEquals($user2->firstname, $record->firstname);

        $this->assertEquals($user2->lastname, $record->lastname);

        $this->assertEquals($user2->email, $record->email);

    }

    /**

     * Create user data for a user.

     *

     * @param  \stdClass $user A user object.

     * @param  \stdClass $course A course.

     */

    protected function create_data_for_user($user, $course) {

        global $DB;

        $this->resetAfterTest();

        // Last course access.

        $lastaccess = (object) [

            'userid' => $user->id,

            'courseid' => $course->id,

            'timeaccess' => time() - DAYSECS

        ];

        $DB->insert_record('user_lastaccess', $lastaccess);

        // Password history.

        $history = (object) [

            'userid' => $user->id,

            'hash' => 'HID098djJUU',

            'timecreated' => time()

        ];

        $DB->insert_record('user_password_history', $history);

        // Password resets.

        $passwordreset = (object) [

            'userid' => $user->id,

            'timerequested' => time(),

            'timererequested' => time(),

            'token' => $this->generate_random_string()

        ];

        $DB->insert_record('user_password_resets', $passwordreset);

        // User mobile devices.

        $userdevices = (object) [

            'userid' => $user->id,

            'appid' => 'com.moodle.moodlemobile',

            'name' => 'occam',

            'model' => 'Nexus 4',

            'platform' => 'Android',

            'version' => '4.2.2',

            'pushid' => 'kishUhd',

            'uuid' => 'KIhud7s',

            'timecreated' => time(),

            'timemodified' => time()

        ];

        $DB->insert_record('user_devices', $userdevices);

        // Course request.

        $courserequest = (object) [

            'fullname' => 'Test Course',

            'shortname' => 'TC',

            'summary' => 'Summary of course',

            'summaryformat' => 1,

            'category' => 1,

            'reason' => 'Because it would be nice.',

            'requester' => $user->id,

            'password' => ''

        ];

        $DB->insert_record('course_request', $courserequest);

        // User session table data.

        $usersessions = (object) [

            'state' => 0,

            'sid' => $this->generate_random_string(), // Needs a unique id.

            'userid' => $user->id,

            'sessdata' => 'Nothing',

            'timecreated' => time(),

            'timemodified' => time(),

            'firstip' => '0.0.0.0',

            'lastip' => '0.0.0.0'

        ];

        $mockhandler = new mock_handler();

        $mockhandler->add_test_session($usersessions);

    }

    /**

     * Create a random string.

     *

     * @param  integer $length length of the string to generate.

     * @return string A random string.

     */

    protected function generate_random_string($length = 6) {

        $response = '';

        $source = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';

        if ($length > 0) {

            $response = '';

            $source = str_split($source, 1);

            for ($i = 1; $i <= $length; $i++) {

                $num = mt_rand(1, count($source));

                $response .= $source[$num - 1];

            }

        }

        return $response;

    }

}