Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?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_repository;

use repository;
use repository_exception;
use repository_type;

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

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

/**
 * Repository API unit tests
 *
 * @package   core_repository
 * @category  test
 * @copyright 2012 Dongsheng Cai {@link http://dongsheng.org}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class repositorylib_test extends \advanced_testcase {

    /**
     * Installing repository tests
     *
     * @copyright 2012 Dongsheng Cai {@link http://dongsheng.org}
     */
    public function test_install_repository() {
        global $CFG, $DB;

        $this->resetAfterTest(true);

        $syscontext = \context_system::instance();
< $repositorypluginname = 'boxnet';
> $repositorypluginname = 'dropbox';
// override repository permission $capability = 'repository/' . $repositorypluginname . ':view'; $guestroleid = $DB->get_field('role', 'id', array('shortname' => 'guest')); assign_capability($capability, CAP_ALLOW, $guestroleid, $syscontext->id, true); $plugintype = new repository_type($repositorypluginname); $pluginid = $plugintype->create(false); $this->assertIsInt($pluginid); $args = array(); $args['type'] = $repositorypluginname; $repos = repository::get_instances($args); $repository = reset($repos); $this->assertInstanceOf('repository', $repository); $info = $repository->get_meta(); $this->assertEquals($repositorypluginname, $info->type); } public function test_get_unused_filename() { global $USER; $this->resetAfterTest(true); $this->setAdminUser(); $fs = get_file_storage(); $draftitemid = null; $context = \context_user::instance($USER->id); file_prepare_draft_area($draftitemid, $context->id, 'phpunit', 'test_get_unused_filename', 1); $dummy = array( 'contextid' => $context->id, 'component' => 'user', 'filearea' => 'draft', 'itemid' => $draftitemid, 'filepath' => '/', 'filename' => '' ); // Create some files. $existingfiles = array( 'test', 'test.txt', 'test (1).txt', 'test1.txt', 'test1 (1).txt', 'test1 (2).txt', 'test1 (3).txt', 'test1 (My name is Bob).txt', 'test2 (555).txt', 'test3 (1000).txt', 'test3 (1000MB).txt', ); foreach ($existingfiles as $filename) { $dummy['filename'] = $filename; $file = $fs->create_file_from_string($dummy, 'blah! ' . $filename); $this->assertTrue(repository::draftfile_exists($draftitemid, '/', $filename)); } // Actual testing. $this->assertEquals('free.txt', repository::get_unused_filename($draftitemid, '/', 'free.txt')); $this->assertEquals('test (1)', repository::get_unused_filename($draftitemid, '/', 'test')); $this->assertEquals('test (2).txt', repository::get_unused_filename($draftitemid, '/', 'test.txt')); $this->assertEquals('test1 (4).txt', repository::get_unused_filename($draftitemid, '/', 'test1.txt')); $this->assertEquals('test1 (8).txt', repository::get_unused_filename($draftitemid, '/', 'test1 (8).txt')); $this->assertEquals('test1 ().txt', repository::get_unused_filename($draftitemid, '/', 'test1 ().txt')); $this->assertEquals('test2 (556).txt', repository::get_unused_filename($draftitemid, '/', 'test2 (555).txt')); $this->assertEquals('test3 (1001).txt', repository::get_unused_filename($draftitemid, '/', 'test3 (1000).txt')); $this->assertEquals('test3 (1000MB) (1).txt', repository::get_unused_filename($draftitemid, '/', 'test3 (1000MB).txt')); $this->assertEquals('test4 (1).txt', repository::get_unused_filename($draftitemid, '/', 'test4 (1).txt')); } public function test_draftfile_exists() { global $USER; $this->resetAfterTest(true); $this->setAdminUser(); $fs = get_file_storage(); $draftitemid = file_get_unused_draft_itemid(); $context = \context_user::instance($USER->id); $dummy = array( 'contextid' => $context->id, 'component' => 'user', 'filearea' => 'draft', 'itemid' => $draftitemid, 'filepath' => '/', 'filename' => '' ); // Create some files. $existingfiles = array( 'The Matrix.movie', 'Astalavista.txt', 'foobar', ); foreach ($existingfiles as $filename) { $dummy['filename'] = $filename; $file = $fs->create_file_from_string($dummy, 'Content of ' . $filename); $this->assertInstanceOf('stored_file', $file); } // Doing the text. foreach ($existingfiles as $filename) { $this->assertTrue(repository::draftfile_exists($draftitemid, '/', $filename)); } foreach (array('Terminator.movie', 'Where is Wally?', 'barfoo') as $filename) { $this->assertFalse(repository::draftfile_exists($draftitemid, '/', $filename)); } } public function test_delete_selected_files() { global $USER; $this->resetAfterTest(true); $this->setAdminUser(); $fs = get_file_storage(); $draftitemid = file_get_unused_draft_itemid(); $context = \context_user::instance($USER->id); $dummy = [ 'contextid' => $context->id, 'component' => 'user', 'filearea' => 'draft', 'itemid' => $draftitemid, 'filepath' => '/', 'filename' => '' ]; // Create some files. $existingfiles = [ 'The Matrix.movie', 'Astalavista.txt', 'foobar', ]; $selectedfiles = [ 'The Matrix.movie' => [], 'Astalavista.txt' => [] ]; foreach ($existingfiles as $filename) { $dummy['filename'] = $filename; $file = $fs->create_file_from_string($dummy, 'Content of ' . $filename); if (array_key_exists($filename, $selectedfiles)) { $selectedfiles[$filename] = (object)[ 'filename' => $filename, 'filepath' => $file->get_filepath() ]; } } // Get area files with default options. $areafiles = $fs->get_area_files($context->id, 'user', 'draft', $draftitemid); // Should be the 3 files we added plus the folder. $this->assertEquals(4, count($areafiles)); repository_delete_selected_files($context, 'user', 'draft', $draftitemid, $selectedfiles); $areafiles = $fs->get_area_files($context->id, 'user', 'draft', $draftitemid); // Should be the 1 file left plus the folder. $this->assertEquals(2, count($areafiles)); } public function test_can_be_edited_by_user() { $this->resetAfterTest(true); $syscontext = \context_system::instance(); $course = $this->getDataGenerator()->create_course(); $coursecontext = \context_course::instance($course->id); $roleid = create_role('A role', 'arole', 'A role', ''); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); // Instance on a site level. $this->getDataGenerator()->create_repository_type('flickr_public'); $repoid = $this->getDataGenerator()->create_repository('flickr_public')->id; $systemrepo = repository::get_repository_by_id($repoid, $syscontext); role_assign($roleid, $user->id, $syscontext->id); assign_capability('moodle/site:config', CAP_ALLOW, $roleid, $syscontext, true); assign_capability('repository/flickr_public:view', CAP_ALLOW, $roleid, $syscontext, true); accesslib_clear_all_caches_for_unit_testing(); $this->assertTrue($systemrepo->can_be_edited_by_user()); assign_capability('repository/flickr_public:view', CAP_PROHIBIT, $roleid, $syscontext, true); assign_capability('moodle/site:config', CAP_PROHIBIT, $roleid, $syscontext, true); accesslib_clear_all_caches_for_unit_testing(); $this->assertFalse($systemrepo->can_be_edited_by_user()); assign_capability('repository/flickr_public:view', CAP_ALLOW, $roleid, $syscontext, true); assign_capability('moodle/site:config', CAP_PROHIBIT, $roleid, $syscontext, true); accesslib_clear_all_caches_for_unit_testing(); $this->assertFalse($systemrepo->can_be_edited_by_user()); role_unassign($roleid, $user->id, $syscontext->id); accesslib_clear_all_caches_for_unit_testing(); // Instance on a course level. $this->getDataGenerator()->enrol_user($user->id, $course->id, $roleid); $params = array('contextid' => $coursecontext->id); $repoid = $this->getDataGenerator()->create_repository('flickr_public', $params)->id; $courserepo = repository::get_repository_by_id($repoid, $coursecontext); assign_capability('moodle/course:update', CAP_ALLOW, $roleid, $coursecontext, true); assign_capability('repository/flickr_public:view', CAP_ALLOW, $roleid, $coursecontext, true); accesslib_clear_all_caches_for_unit_testing(); $this->assertTrue($courserepo->can_be_edited_by_user()); assign_capability('repository/flickr_public:view', CAP_PROHIBIT, $roleid, $coursecontext, true); accesslib_clear_all_caches_for_unit_testing(); $this->assertFalse($courserepo->can_be_edited_by_user()); assign_capability('moodle/course:update', CAP_ALLOW, $roleid, $coursecontext, true); assign_capability('repository/flickr_public:view', CAP_PROHIBIT, $roleid, $coursecontext, true); accesslib_clear_all_caches_for_unit_testing(); $this->assertFalse($courserepo->can_be_edited_by_user()); role_unassign($roleid, $user->id, $coursecontext->id); accesslib_clear_all_caches_for_unit_testing(); // Instance on a user level. $otheruser = $this->getDataGenerator()->create_user(); $otherusercontext = \context_user::instance($otheruser->id); role_assign($roleid, $user->id, $syscontext->id); assign_capability('repository/flickr_public:view', CAP_ALLOW, $roleid, $syscontext, true); accesslib_clear_all_caches_for_unit_testing(); // Editing someone else's instance. $record = array('contextid' => $otherusercontext->id); $repoid = $this->getDataGenerator()->create_repository('flickr_public', $record)->id; $userrepo = repository::get_repository_by_id($repoid, $syscontext); $this->assertFalse($userrepo->can_be_edited_by_user()); // Editing my own instance. $usercontext = \context_user::instance($user->id); $record = array('contextid' => $usercontext->id); $repoid = $this->getDataGenerator()->create_repository('flickr_public', $record)->id; $userrepo = repository::get_repository_by_id($repoid, $syscontext); $this->assertTrue($userrepo->can_be_edited_by_user()); } public function test_check_capability() { $this->resetAfterTest(true); $syscontext = \context_system::instance(); $course1 = $this->getDataGenerator()->create_course(); $course1context = \context_course::instance($course1->id); $course2 = $this->getDataGenerator()->create_course(); $course2context = \context_course::instance($course2->id); $forumdata = new \stdClass(); $forumdata->course = $course1->id; $forumc1 = $this->getDataGenerator()->create_module('forum', $forumdata); $forumc1context = \context_module::instance($forumc1->cmid); $forumdata->course = $course2->id; $forumc2 = $this->getDataGenerator()->create_module('forum', $forumdata); $forumc2context = \context_module::instance($forumc2->cmid); $blockdata = new \stdClass(); $blockdata->parentcontextid = $course1context->id; $blockc1 = $this->getDataGenerator()->create_block('online_users', $blockdata); $blockc1context = \context_block::instance($blockc1->id); $blockdata->parentcontextid = $course2context->id; $blockc2 = $this->getDataGenerator()->create_block('online_users', $blockdata); $blockc2context = \context_block::instance($blockc2->id); $user1 = $this->getDataGenerator()->create_user(); $user1context = \context_user::instance($user1->id); $user2 = $this->getDataGenerator()->create_user(); $user2context = \context_user::instance($user2->id); // New role prohibiting Flickr Public access. $roleid = create_role('No Flickr Public', 'noflickrpublic', 'No Flickr Public', ''); assign_capability('repository/flickr_public:view', CAP_PROHIBIT, $roleid, $syscontext, true); // Disallow system access to Flickr Public to user 2. role_assign($roleid, $user2->id, $syscontext->id); accesslib_clear_all_caches_for_unit_testing(); // Enable repositories. $this->getDataGenerator()->create_repository_type('flickr_public'); $this->getDataGenerator()->create_repository_type('dropbox'); // Instance on a site level. $repoid = $this->getDataGenerator()->create_repository('flickr_public')->id; $systemrepo = repository::get_repository_by_id($repoid, $syscontext); // Check that everyone with right capability can view a site-wide repository. $this->setUser($user1); $this->assertTrue($systemrepo->check_capability()); // Without the capability, we cannot view a site-wide repository. $this->setUser($user2); $caughtexception = false; try { $systemrepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // Instance on a course level. $record = new \stdClass(); $record->contextid = $course1context->id; $courserepoid = $this->getDataGenerator()->create_repository('flickr_public', $record)->id; // Within the course, I can view the repository. $courserepo = repository::get_repository_by_id($courserepoid, $course1context); $this->setUser($user1); $this->assertTrue($courserepo->check_capability()); // But not without the capability. $this->setUser($user2); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // From another course I cannot, with or without the capability. $courserepo = repository::get_repository_by_id($courserepoid, $course2context); $this->setUser($user1); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); $this->setUser($user2); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // From a module within the course, I can view the repository. $courserepo = repository::get_repository_by_id($courserepoid, $forumc1context); $this->setUser($user1); $this->assertTrue($courserepo->check_capability()); // But not without the capability. $this->setUser($user2); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // From a module in the wrong course, I cannot view the repository. $courserepo = repository::get_repository_by_id($courserepoid, $forumc2context); $this->setUser($user1); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // From a block within the course, I can view the repository. $courserepo = repository::get_repository_by_id($courserepoid, $blockc1context); $this->setUser($user1); $this->assertTrue($courserepo->check_capability()); // But not without the capability. $this->setUser($user2); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // From a block in the wrong course, I cannot view the repository. $courserepo = repository::get_repository_by_id($courserepoid, $blockc2context); $this->setUser($user1); $caughtexception = false; try { $courserepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // Instance on a user level. // Instance on a course level. $record = new \stdClass(); $record->contextid = $user1context->id; $user1repoid = $this->getDataGenerator()->create_repository('flickr_public', $record)->id; $record->contextid = $user2context->id; $user2repoid = $this->getDataGenerator()->create_repository('flickr_public', $record)->id; // Check that a user can see its own repository. $userrepo = repository::get_repository_by_id($user1repoid, $syscontext); $this->setUser($user1); $this->assertTrue($userrepo->check_capability()); // But not without the capability. $userrepo = repository::get_repository_by_id($user2repoid, $syscontext); $this->setUser($user2); $caughtexception = false; try { $userrepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // Check that a user cannot see someone's repository. $userrepo = repository::get_repository_by_id($user2repoid, $syscontext); $this->setUser($user1); $caughtexception = false; try { $userrepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // Make sure the repo from user 2 was accessible. role_unassign($roleid, $user2->id, $syscontext->id); accesslib_clear_all_caches_for_unit_testing(); $this->setUser($user2); $this->assertTrue($userrepo->check_capability()); role_assign($roleid, $user2->id, $syscontext->id); accesslib_clear_all_caches_for_unit_testing(); // Check that a user can view SOME repositories when logged in as someone else. $params = new \stdClass(); $params->name = 'Dropbox';
< $params->dropbox_key = 'key'; < $params->dropbox_secret = 'secret';
> $params->dropbox_issuerid = '2';
$privaterepoid = $this->getDataGenerator()->create_repository('dropbox')->id; $notprivaterepoid = $this->getDataGenerator()->create_repository('upload')->id; $privaterepo = repository::get_repository_by_id($privaterepoid, $syscontext); $notprivaterepo = repository::get_repository_by_id($notprivaterepoid, $syscontext); $userrepo = repository::get_repository_by_id($user1repoid, $syscontext); $this->setAdminUser(); \core\session\manager::loginas($user1->id, $syscontext); // Logged in as, I cannot view a user instance. $caughtexception = false; try { $userrepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // Logged in as, I cannot view a private instance. $caughtexception = false; try { $privaterepo->check_capability(); } catch (repository_exception $e) { $caughtexception = true; } $this->assertTrue($caughtexception); // Logged in as, I can view a non-private instance. $this->assertTrue($notprivaterepo->check_capability()); } function test_delete_all_for_context() { global $DB; $this->resetAfterTest(true); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $user = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->create_repository_type('flickr_public'); $this->getDataGenerator()->create_repository_type('filesystem'); $coursecontext = \context_course::instance($course->id); $usercontext = \context_user::instance($user->id); // Creating course instances. $repo = $this->getDataGenerator()->create_repository('flickr_public', array('contextid' => $coursecontext->id)); $courserepo1 = repository::get_repository_by_id($repo->id, $coursecontext); $this->assertEquals(1, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); $repo = $this->getDataGenerator()->create_repository('filesystem', array('contextid' => $coursecontext->id)); $courserepo2 = repository::get_repository_by_id($repo->id, $coursecontext); $this->assertEquals(2, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); // Creating user instances. $repo = $this->getDataGenerator()->create_repository('flickr_public', array('contextid' => $usercontext->id)); $userrepo1 = repository::get_repository_by_id($repo->id, $usercontext); $this->assertEquals(1, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); $repo = $this->getDataGenerator()->create_repository('filesystem', array('contextid' => $usercontext->id)); $userrepo2 = repository::get_repository_by_id($repo->id, $usercontext); $this->assertEquals(2, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); // Simulation of course deletion. repository::delete_all_for_context($coursecontext->id); $this->assertEquals(0, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); $this->assertEquals(0, $DB->count_records('repository_instances', array('id' => $courserepo1->id))); $this->assertEquals(0, $DB->count_records('repository_instances', array('id' => $courserepo2->id))); $this->assertEquals(0, $DB->count_records('repository_instance_config', array('instanceid' => $courserepo1->id))); $this->assertEquals(0, $DB->count_records('repository_instance_config', array('instanceid' => $courserepo2->id))); // Simulation of user deletion. repository::delete_all_for_context($usercontext->id); $this->assertEquals(0, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); $this->assertEquals(0, $DB->count_records('repository_instances', array('id' => $userrepo1->id))); $this->assertEquals(0, $DB->count_records('repository_instances', array('id' => $userrepo2->id))); $this->assertEquals(0, $DB->count_records('repository_instance_config', array('instanceid' => $userrepo1->id))); $this->assertEquals(0, $DB->count_records('repository_instance_config', array('instanceid' => $userrepo2->id))); // Checking deletion upon course context deletion. $course = $this->getDataGenerator()->create_course(); $coursecontext = \context_course::instance($course->id); $repo = $this->getDataGenerator()->create_repository('flickr_public', array('contextid' => $coursecontext->id)); $courserepo = repository::get_repository_by_id($repo->id, $coursecontext); $this->assertEquals(1, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); $coursecontext->delete(); $this->assertEquals(0, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); // Checking deletion upon user context deletion. $user = $this->getDataGenerator()->create_user(); $usercontext = \context_user::instance($user->id); $repo = $this->getDataGenerator()->create_repository('flickr_public', array('contextid' => $usercontext->id)); $userrepo = repository::get_repository_by_id($repo->id, $usercontext); $this->assertEquals(1, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); $usercontext->delete(); $this->assertEquals(0, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); // Checking deletion upon course deletion. $course = $this->getDataGenerator()->create_course(); $coursecontext = \context_course::instance($course->id); $repo = $this->getDataGenerator()->create_repository('flickr_public', array('contextid' => $coursecontext->id)); $courserepo = repository::get_repository_by_id($repo->id, $coursecontext); $this->assertEquals(1, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); delete_course($course, false); $this->assertEquals(0, $DB->count_records('repository_instances', array('contextid' => $coursecontext->id))); // Checking deletion upon user deletion. $user = $this->getDataGenerator()->create_user(); $usercontext = \context_user::instance($user->id); $repo = $this->getDataGenerator()->create_repository('flickr_public', array('contextid' => $usercontext->id)); $userrepo = repository::get_repository_by_id($repo->id, $usercontext); $this->assertEquals(1, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); delete_user($user); $this->assertEquals(0, $DB->count_records('repository_instances', array('contextid' => $usercontext->id))); } /** * Create test file in user private files * * @param string $filepath file path * @param string $filename file name */ private function create_user_private_file(string $filepath, string $filename): void { global $USER; $filerecord = []; $filerecord['contextid'] = \context_user::instance($USER->id)->id; $filerecord['component'] = 'user'; $filerecord['filearea'] = 'private'; $filerecord['itemid'] = 0; $filerecord['filepath'] = $filepath; $filerecord['filename'] = $filename; $filerecord['userid'] = $USER->id; $fs = get_file_storage(); $fs->create_file_from_string($filerecord, hash("md5", $filepath . $filename)); } public function test_listing_and_filter() { $this->resetAfterTest(true); $this->setUser($this->getDataGenerator()->create_user()); $repoid = $this->getDataGenerator()->create_repository('user')->id; $this->create_user_private_file('/', 'image1.jpg'); $this->create_user_private_file('/', 'file1.txt'); $this->create_user_private_file('/folder/', 'image2.jpg'); $this->create_user_private_file('/folder/', 'file2.txt'); $this->create_user_private_file('/ftexts/', 'file3.txt'); // Listing without filters returns 4 records (2 files and 2 directories). $repo = repository::get_repository_by_id($repoid, \context_system::instance()); $this->assertCount(4, $repo->get_listing()['list']); // Listing with filters returns 3 records (1 files and 2 directories). $_POST['accepted_types'] = ['.jpg']; $this->assertCount(3, $repo->get_listing()['list']); } }