Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.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 logstore_legacy; /** > * Legacy log store tests. > defined('MOODLE_INTERNAL') || die(); * > * @package logstore_legacy > require_once(__DIR__ . '/fixtures/event.php'); * @copyright 2014 Petr Skoda {@link http://skodak.org/} > require_once(__DIR__ . '/fixtures/store.php'); * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later >
*/
< < defined('MOODLE_INTERNAL') || die(); < < require_once(__DIR__ . '/fixtures/event.php'); < require_once(__DIR__ . '/fixtures/store.php'); < < class logstore_legacy_store_testcase extends advanced_testcase {
> class store_test extends \advanced_testcase {
public function test_log_writing() { global $DB; $this->resetAfterTest(); $this->setAdminUser(); $user1 = $this->getDataGenerator()->create_user(); $course1 = $this->getDataGenerator()->create_course(); $module1 = $this->getDataGenerator()->create_module('resource', array('course' => $course1)); $course2 = $this->getDataGenerator()->create_course(); // Enable legacy logging plugin. set_config('enabled_stores', 'logstore_legacy', 'tool_log'); set_config('loglegacy', 1, 'logstore_legacy'); $manager = get_log_manager(true); $stores = $manager->get_readers(); $this->assertCount(1, $stores); $this->assertEquals(array('logstore_legacy'), array_keys($stores)); $store = $stores['logstore_legacy']; $this->assertInstanceOf('logstore_legacy\log\store', $store); $this->assertInstanceOf('core\log\sql_reader', $store); $this->assertTrue($store->is_logging()); $logs = $DB->get_records('log', array(), 'id ASC'); $this->assertCount(0, $logs); $this->setCurrentTimeStart(); $this->setUser(0); $event1 = \logstore_legacy\event\unittest_executed::create(
< array('context' => context_module::instance($module1->cmid), 'other' => array('sample' => 5, 'xx' => 10)));
> array('context' => \context_module::instance($module1->cmid), 'other' => array('sample' => 5, 'xx' => 10)));
$event1->trigger(); $this->setUser($user1); $event2 = \logstore_legacy\event\unittest_executed::create(
< array('context' => context_course::instance($course2->id), 'other' => array('sample' => 6, 'xx' => 11)));
> array('context' => \context_course::instance($course2->id), 'other' => array('sample' => 6, 'xx' => 11)));
$event2->trigger(); $logs = $DB->get_records('log', array(), 'id ASC'); $this->assertCount(2, $logs); $log = array_shift($logs); $this->assertNotEmpty($log->id); $this->assertTimeCurrent($log->time); $this->assertEquals(0, $log->userid); $this->assertSame('0.0.0.0', $log->ip); $this->assertEquals($course1->id, $log->course); $this->assertSame('core_unittest', $log->module); $this->assertEquals($module1->cmid, $log->cmid); $this->assertSame('view', $log->action); $this->assertSame('unittest.php?id=5', $log->url); $this->assertSame('bbb', $log->info); $oldlogid = $log->id; $log = array_shift($logs); $this->assertGreaterThan($oldlogid, $log->id); $this->assertNotEmpty($log->id); $this->assertTimeCurrent($log->time); $this->assertEquals($user1->id, $log->userid); $this->assertSame('0.0.0.0', $log->ip); $this->assertEquals($course2->id, $log->course); $this->assertSame('core_unittest', $log->module); $this->assertEquals(0, $log->cmid); $this->assertSame('view', $log->action); $this->assertSame('unittest.php?id=6', $log->url); $this->assertSame('bbb', $log->info); // Test if disabling works. set_config('enabled_stores', 'logstore_legacy', 'tool_log'); set_config('loglegacy', 0, 'logstore_legacy'); $manager = get_log_manager(true); $stores = $manager->get_readers(); $store = $stores['logstore_legacy']; $this->assertFalse($store->is_logging()); \logstore_legacy\event\unittest_executed::create( array('context' => \context_system::instance(), 'other' => array('sample' => 5, 'xx' => 10)))->trigger(); $this->assertEquals(2, $DB->count_records('log')); // Another way to disable legacy completely. set_config('enabled_stores', 'logstore_standard', 'tool_log'); set_config('loglegacy', 1, 'logstore_legacy'); get_log_manager(true); \logstore_legacy\event\unittest_executed::create( array('context' => \context_system::instance(), 'other' => array('sample' => 5, 'xx' => 10)))->trigger(); $this->assertEquals(2, $DB->count_records('log')); // Set everything back. set_config('enabled_stores', '', 'tool_log'); set_config('loglegacy', 0, 'logstore_legacy'); get_log_manager(true); } /** * Test replace_sql_legacy() */ public function test_replace_sql_legacy() { $selectwhere = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since"; $params = array('userid' => 2, 'since' => 3, 'courseid' => 4, 'eventname' => '\core\event\course_created'); $expectedselect = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since"; $expectedparams = $params + array('url' => "view.php?id=4"); list($replaceselect, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals($replaceselect, $expectedselect); $this->assertEquals($replaceparams, $expectedparams); // Test CRUD related changes. $selectwhere = "edulevel = 0"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals($selectwhere, $updatewhere); $selectwhere = "edulevel = 0 and crud = 'u'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action LIKE '%update%'", $updatewhere); $selectwhere = "edulevel = 0 and crud != 'u'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action NOT LIKE '%update%'", $updatewhere); $selectwhere = "edulevel = 0 and crud <> 'u'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action NOT LIKE '%update%'", $updatewhere); $selectwhere = "edulevel = 0 and crud = 'r'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action LIKE '%view%' OR action LIKE '%report%'", $updatewhere); $selectwhere = "edulevel = 0 and crud != 'r'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action NOT LIKE '%view%' AND action NOT LIKE '%report%'", $updatewhere); $selectwhere = "edulevel = 0 and crud <> 'r'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action NOT LIKE '%view%' AND action NOT LIKE '%report%'", $updatewhere); // The slq is incorrect, since quotes must not be present. Make sure this is not parsed. $selectwhere = "edulevel = 0 and 'crud' != 'u'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertNotEquals("edulevel = 0 and action NOT LIKE '%update%'", $updatewhere); $selectwhere = "edulevel = 0 and crud = 'u' OR crud != 'r' or crud <> 'd'"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("edulevel = 0 and action LIKE '%update%' OR action NOT LIKE '%view%' AND action NOT LIKE '%report%' or action NOT LIKE '%delete%'", $updatewhere); // The anonymous select returns all data. $selectwhere = "anonymous = 0"; list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertSame("0 = 0", $updatewhere); // Test legacy field names are mapped. $selectwhere = "timecreated = :timecreated and courseid = :courseid and contextinstanceid = :contextinstanceid and origin = :origin"; $params = array('timecreated' => 2, 'courseid' => 3, 'contextinstanceid' => 4, 'origin' => 5 ); $expectedparams = array('time' => 2, 'course' => 3, 'cmid' => 4, 'ip' => 5); list($updatewhere, $replaceparams) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params); $this->assertEquals("time = :time and course = :course and cmid = :cmid and ip = :ip", $updatewhere); $this->assertSame($expectedparams, $replaceparams); // Test sorting parameters. $selectwhere = "courseid = 3"; $params = array(); $sort = 'timecreated DESC'; list($updatewhere, $replaceparams, $sort) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params, $sort); $this->assertSame('time DESC', $sort); $sort = 'courseid DESC'; list($updatewhere, $replaceparams, $sort) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params, $sort); $this->assertSame('course DESC', $sort); $sort = 'contextinstanceid DESC'; list($updatewhere, $replaceparams, $sort) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params, $sort); $this->assertSame('cmid DESC', $sort); $sort = 'origin DESC'; list($updatewhere, $replaceparams, $sort) = \logstore_legacy\test\unittest_logstore_legacy::replace_sql_legacy($selectwhere, $params, $sort); $this->assertSame('ip DESC', $sort); } /* * Test logmanager::get_supported_reports returns all reports that require this store. */ public function test_get_supported_reports() { $logmanager = get_log_manager(); $allreports = \core_component::get_plugin_list('report');
< $supportedreports = array( < 'report_log' => '/report/log', < 'report_loglive' => '/report/loglive', < 'report_outline' => '/report/outline', < 'report_participation' => '/report/participation', < 'report_stats' => '/report/stats' < ); <
// Make sure all supported reports are installed.
< $expectedreports = array_keys(array_intersect_key($allreports, $supportedreports)); < $reports = $logmanager->get_supported_reports('logstore_legacy'); < $reports = array_keys($reports);
> $expectedreports = array_intersect_key([ > 'log' => 'report_log', > 'loglive' => 'report_loglive', > 'outline' => 'report_outline', > 'participation' => 'report_participation', > 'stats' => 'report_stats' > ], $allreports); > > $supportedreports = $logmanager->get_supported_reports('logstore_legacy'); >
foreach ($expectedreports as $expectedreport) {
< $this->assertContains($expectedreport, $reports);
> $this->assertArrayHasKey($expectedreport, $supportedreports);
} } /** * Test that the legacy log cleanup works correctly. */ public function test_cleanup_task() { global $DB; $this->resetAfterTest(); // Create some records spread over various days; test multiple iterations in cleanup. $record = (object) array('time' => time()); $DB->insert_record('log', $record); $record->time -= 3600 * 24 * 30; $DB->insert_record('log', $record); $record->time -= 3600 * 24 * 30; $DB->insert_record('log', $record); $record->time -= 3600 * 24 * 30; $DB->insert_record('log', $record); $this->assertEquals(4, $DB->count_records('log')); // Remove all logs before "today". set_config('loglifetime', 1); $this->expectOutputString(" Deleted old legacy log records\n"); $clean = new \logstore_legacy\task\cleanup_task(); $clean->execute(); $this->assertEquals(1, $DB->count_records('log')); } }