MDL-40051 core_mnet: replaced add_to_log calls with events

lang/en/mnet.php

@@ -65,6 +65,8 @@
 $string['error7024'] = 'You send an unencrypted message to the remote site, but the remote site doesn\'t accept unencrypted communication from your site. This is very unexpected; you should probably file a bug if this occurs (giving as much information as possible about the application versions in question, etc.';
 $string['error7026'] = 'The key that your message was signed with differs from the key that the remote host has on file for your server. Further, the remote host attempted to fetch your current key and failed to do so. Please manually re-key with the remote host and try again.';
 $string['error709'] = 'The remote site failed to obtain a SSL key from you.';
+$string['eventaccesscontrolcreated'] = 'Access control created';
+$string['eventaccesscontrolupdated'] = 'Access control updated';
 $string['expired'] = 'This key expired on';
 $string['expires'] = 'Valid until';
 $string['expireyourkey'] = 'Delete this key';

lib/classes/event/mnet_access_control_created.php

@@ -0,0 +1,83 @@
+<?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/>.
+
+/**
+ * Mnet access control created event class.
+ *
+ * @package    core
+ * @copyright  2013 Mark Nelson <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+class mnet_access_control_created extends base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'mnet_sso_access_control';
+        $this->data['crud'] = 'c';
+        $this->data['level'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventaccesscontrolcreated', 'mnet');
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('admin/mnet/access_control.php');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        $mnetaccesscontrol = $this->get_record_snapshot('mnet_sso_access_control', $this->objectid);
+        $mnethost = $this->get_record_snapshot('mnet_host', $mnetaccesscontrol->mnet_host_id);
+
+        return 'Access control created for the user with the username \'' . $mnetaccesscontrol->username . '\' belonging
+            to the mnet host \'' . $mnethost->name . '\'';
+    }
+
+    /**
+     * Return legacy data for add_to_log().
+     *
+     * @return array
+     */
+    protected function get_legacy_logdata() {
+        $mnetaccesscontrol = $this->get_record_snapshot('mnet_sso_access_control', $this->objectid);
+        $mnethost = $this->get_record_snapshot('mnet_host', $mnetaccesscontrol->mnet_host_id);
+
+        return array($this->courseid, 'admin/mnet', 'add', 'admin/mnet/access_control.php', 'SSO ACL: ' .
+            $mnetaccesscontrol->accessctrl . ' user \'' . $mnetaccesscontrol->username . '\' from ' .
+            $mnethost->name);
+    }
+}

lib/classes/event/mnet_access_control_updated.php

@@ -0,0 +1,83 @@
+<?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/>.
+
+/**
+ * Mnet access control updated event class.
+ *
+ * @package    core
+ * @copyright  2013 Mark Nelson <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+class mnet_access_control_updated extends base {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'mnet_sso_access_control';
+        $this->data['crud'] = 'u';
+        $this->data['level'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventaccesscontrolupdated', 'mnet');
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        return new \moodle_url('admin/mnet/access_control.php');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        $mnetaccesscontrol = $this->get_record_snapshot('mnet_sso_access_control', $this->objectid);
+        $mnethost = $this->get_record_snapshot('mnet_host', $mnetaccesscontrol->mnet_host_id);
+
+        return 'Access control created for the user with the username \'' . $mnetaccesscontrol->username . '\' belonging
+            to the mnet host \'' . $mnethost->name . '\'';
+    }
+
+    /**
+     * Return legacy data for add_to_log().
+     *
+     * @return array
+     */
+    protected function get_legacy_logdata() {
+        $mnetaccesscontrol = $this->get_record_snapshot('mnet_sso_access_control', $this->objectid);
+        $mnethost = $this->get_record_snapshot('mnet_host', $mnetaccesscontrol->mnet_host_id);
+
+        return array($this->courseid, 'admin/mnet', 'update', 'admin/mnet/access_control.php', 'SSO ACL: ' .
+            $mnetaccesscontrol->accessctrl . ' user \'' . $mnetaccesscontrol->username . '\' from ' .
+            $mnethost->name);
+    }
+}

mnet/lib.php

@@ -440,20 +440,36 @@ function mnet_update_sso_access_control($username, $mnet_host_id, $accessctrl) {
 
     $mnethost = $DB->get_record('mnet_host', array('id'=>$mnet_host_id));
     if ($aclrecord = $DB->get_record('mnet_sso_access_control', array('username'=>$username, 'mnet_host_id'=>$mnet_host_id))) {
-        // update
+        // Update.
         $aclrecord->accessctrl = $accessctrl;
         $DB->update_record('mnet_sso_access_control', $aclrecord);
-        add_to_log(SITEID, 'admin/mnet', 'update', 'admin/mnet/access_control.php',
-                "SSO ACL: $accessctrl user '$username' from {$mnethost->name}");
+
+        // Trigger access control updated event.
+        $params = array(
+            'objectid' => $aclrecord->id,
+            'courseid' => SITEID,
+            'context' => context_system::instance()
+        );
+        $event = \core\event\mnet_access_control_updated::create($params);
+        $event->add_record_snapshot('mnet_host', $mnethost);
+        $event->trigger();
     } else {
-        // insert
+        // Insert.
         $aclrecord = new stdClass();
         $aclrecord->username = $username;
         $aclrecord->accessctrl = $accessctrl;
         $aclrecord->mnet_host_id = $mnet_host_id;
-        $id = $DB->insert_record('mnet_sso_access_control', $aclrecord);
-        add_to_log(SITEID, 'admin/mnet', 'add', 'admin/mnet/access_control.php',
-                "SSO ACL: $accessctrl user '$username' from {$mnethost->name}");
+        $aclrecord->id = $DB->insert_record('mnet_sso_access_control', $aclrecord);
+
+        // Trigger access control created event.
+        $params = array(
+            'objectid' => $aclrecord->id,
+            'courseid' => SITEID,
+            'context' => context_system::instance()
+        );
+        $event = \core\event\mnet_access_control_created::create($params);
+        $event->add_record_snapshot('mnet_host', $mnethost);
+        $event->trigger();
     }
     return true;
 }

mnet/tests/events_test.php

@@ -0,0 +1,98 @@
+<?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/>.
+
+/**
+ * Events tests.
+ *
+ * @package   core_mnet
+ * @category  test
+ * @copyright 2013 Mark Nelson <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/mnet/lib.php');
+
+class mnet_events_testcase extends advanced_testcase {
+
+    /** @var stdClass the mnet host we are using to test */
+    protected $mnethost;
+
+    /**
+     * Test set up.
+     *
+     * This is executed before running any test in this file.
+     */
+    public function setUp() {
+        global $DB;
+
+        $this->resetAfterTest();
+
+        // Add a mnet host.
+        $this->mnethost = new stdClass();
+        $this->mnethost->name = 'A mnet host';
+        $this->mnethost->public_key = 'A random public key!';
+        $this->mnethost->id = $DB->insert_record('mnet_host', $this->mnethost);
+    }
+
+    /**
+     * Test the mnet access control created event.
+     */
+    public function test_mnet_access_control_created() {
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        mnet_update_sso_access_control('username', $this->mnethost->id, 'enabled');
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        // Check that the event data is valid.
+        $this->assertInstanceOf('\core\event\mnet_access_control_created', $event);
+        $this->assertEquals(context_system::instance(), $event->get_context());
+        $expected = array(SITEID, 'admin/mnet', 'add', 'admin/mnet/access_control.php',
+            'SSO ACL: enabled user \'username\' from ' . $this->mnethost->name);
+        $this->assertEventLegacyLogData($expected, $event);
+    }
+
+    /**
+     * Test the mnet access control updated event.
+     */
+    public function test_mnet_access_control_updated() {
+        global $DB;
+
+        // Create a mnet access control.
+        $mnetaccesscontrol = new stdClass();
+        $mnetaccesscontrol->username = 'username';
+        $mnetaccesscontrol->mnet_host_id = $this->mnethost->id;
+        $mnetaccesscontrol->accessctrl = 'enabled';
+        $mnetaccesscontrol->id = $DB->insert_record('mnet_sso_access_control', $mnetaccesscontrol);
+
+        // Trigger and capture the event.
+        $sink = $this->redirectEvents();
+        mnet_update_sso_access_control('username', $this->mnethost->id, 'enabled');
+        $events = $sink->get_events();
+        $event = reset($events);
+
+        // Check that the event data is valid.
+        $this->assertInstanceOf('\core\event\mnet_access_control_updated', $event);
+        $this->assertEquals(context_system::instance(), $event->get_context());
+        $expected = array(SITEID, 'admin/mnet', 'update', 'admin/mnet/access_control.php',
+            'SSO ACL: enabled user \'username\' from ' . $this->mnethost->name);
+        $this->assertEventLegacyLogData($expected, $event);
+    }
+}