first commit

enrol/mnet/classes/privacy/provider.php

@@ -0,0 +1,41 @@
+<?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 Subsystem implementation for enrol_mnet.
+ *
+ * @package    enrol_mnet
+ * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace enrol_mnet\privacy;
+defined('MOODLE_INTERNAL') || die();
+/**
+ * Privacy Subsystem for enrol_mnet implementing null_provider.
+ *
+ * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

enrol/mnet/db/access.php

@@ -0,0 +1,36 @@
+<?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/>.
+
+/**
+ * Capabilities for mnet enrolment plugin.
+ *
+ * @package    enrol_mnet
+ * @copyright  2014 Daniel Neis Araujo
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$capabilities = array(
+    'enrol/mnet:config' => array(
+        'captype' => 'write',
+        'contextlevel' => CONTEXT_COURSE,
+        'archetypes' => array(
+            'manager' => CAP_ALLOW,
+            'editingteacher' => CAP_ALLOW,
+        )
+    ),
+);

enrol/mnet/db/mnet.php

@@ -0,0 +1,53 @@
+<?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/>.
+
+/**
+ * This file contains the mnet services for the mnet enrolment plugin
+ *
+ * If we rewrite MNet as proposed in MDL-21993 this file would contain
+ * just a declaration of xml-rpc methods that this plugin publishes.
+ *
+ * @since      Moodle 2.0
+ * @package    enrol_mnet
+ * @copyright  2010 Penny Leach
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$publishes = array(
+    'mnet_enrol' => array(
+        'apiversion' => 1,
+        'classname'  => 'enrol_mnet_mnetservice_enrol',
+        'filename'   => 'enrol.php',
+        'methods'    => array(
+            'available_courses',
+            'user_enrolments',
+            'enrol_user',
+            'unenrol_user',
+            'course_enrolments'
+        ),
+    ),
+);
+$subscribes = array(
+    'mnet_enrol' => array(
+        'available_courses' => 'enrol/mnet/enrol.php/available_courses',
+        'user_enrolments'   => 'enrol/mnet/enrol.php/user_enrolments',
+        'enrol_user'        => 'enrol/mnet/enrol.php/enrol_user',
+        'unenrol_user'      => 'enrol/mnet/enrol.php/unenrol_user',
+        'course_enrolments' => 'enrol/mnet/enrol.php/course_enrolments',
+    ),
+);

enrol/mnet/db/upgrade.php

@@ -0,0 +1,39 @@
+<?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/>.
+
+/**
+ * Keeps track of upgrades to the enrol_mnet plugin
+ *
+ * @package    enrol_mnet
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+function xmldb_enrol_mnet_upgrade($oldversion) {
+    // Automatically generated Moodle v4.1.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    // Automatically generated Moodle v4.2.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    // Automatically generated Moodle v4.3.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    // Automatically generated Moodle v4.4.0 release upgrade line.
+    // Put any upgrade step following this.
+
+    return true;
+}

enrol/mnet/enrol.php

@@ -0,0 +1,357 @@
+<?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/>.
+
+/**
+ * Implements the XML-RPC methods this plugin publishes to MNet peers
+ *
+ * This file must be named enrol.php because current MNet framework has the
+ * filename hardcoded in XML-RPC path and we want to be compatible with
+ * Moodle 1.x MNet clients. There is a proposal in MDL-21993 to allow
+ * map XMP-RPC calls to whatever file, function, class or methods. Once this
+ * is fixed, this file will be probably renamed to mnetlib.php (which could
+ * be a common name of a plugin library containing functions/methods callable
+ * via MNet framework.
+ *
+ * @package    enrol_mnet
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * MNet server-side methods that are part of mnetservice_enrol
+ *
+ * The weird name of the class tries to follow a pattern
+ * {plugintype}_{pluginnname}_mnetservice_{servicename}
+ *
+ * Class methods are compatible with API 1 of the service used by Moodle 1.x
+ * and 2.0 peers. The API version might become a part of class name but it is
+ * not neccessary due to how xml-rcp methods are/will be mapped to php methods.
+ */
+class enrol_mnet_mnetservice_enrol {
+
+    /**
+     * Returns list of courses that we offer to the caller for remote enrolment of their users
+     *
+     * Since Moodle 2.0, courses are made available for MNet peers by creating an instance
+     * of enrol_mnet plugin for the course. Hidden courses are not returned. If there are two
+     * instances - one specific for the host and one for 'All hosts', the setting of the specific
+     * one is used. The id of the peer is kept in customint1, no other custom fields are used.
+     *
+     * @uses mnet_remote_client Callable via XML-RPC only
+     * @return array
+     */
+    public function available_courses() {
+        global $CFG, $DB;
+        require_once($CFG->libdir.'/filelib.php');
+
+        if (!$client = get_mnet_remote_client()) {
+            die('Callable via XML-RPC only');
+        }
+
+        // we call our id as 'remoteid' because it will be sent to the peer
+        // the column aliases are required by MNet protocol API for clients 1.x and 2.0
+        $sql = "SELECT c.id AS remoteid, c.fullname, c.shortname, c.idnumber, c.summary, c.summaryformat,
+                       c.sortorder, c.startdate, cat.id AS cat_id, cat.name AS cat_name,
+                       cat.description AS cat_description, cat.descriptionformat AS cat_descriptionformat,
+                       e.cost, e.currency, e.roleid AS defaultroleid, r.name AS defaultrolename,
+                       e.customint1
+                  FROM {enrol} e
+            INNER JOIN {course} c ON c.id = e.courseid
+            INNER JOIN {course_categories} cat ON cat.id = c.category
+            INNER JOIN {role} r ON r.id = e.roleid
+                 WHERE e.enrol = 'mnet'
+                       AND (e.customint1 = 0 OR e.customint1 = ?)
+                       AND c.visible = 1
+              ORDER BY cat.sortorder, c.sortorder, c.shortname";
+
+        $rs = $DB->get_recordset_sql($sql, array($client->id));
+
+        $courses = array();
+        foreach ($rs as $course) {
+            // use the record if it does not exist yet or is host-specific
+            if (empty($courses[$course->remoteid]) or ($course->customint1 > 0)) {
+                unset($course->customint1); // the client does not need to know this
+                $context = context_course::instance($course->remoteid);
+                // Rewrite file URLs so that they are correct
+                $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', false);
+                $courses[$course->remoteid] = $course;
+            }
+        }
+        $rs->close();
+
+        return array_values($courses); // can not use keys for backward compatibility
+    }
+
+    /**
+     * This method has never been implemented in Moodle MNet API
+     *
+     * @uses mnet_remote_client Callable via XML-RPC only
+     * @return array empty array
+     */
+    public function user_enrolments() {
+        global $CFG, $DB;
+
+        if (!$client = get_mnet_remote_client()) {
+            die('Callable via XML-RPC only');
+        }
+        return array();
+    }
+
+    /**
+     * Enrol remote user to our course
+     *
+     * If we do not have local record for the remote user in our database,
+     * it gets created here.
+     *
+     * @uses mnet_remote_client Callable via XML-RPC only
+     * @param array $userdata user details {@see mnet_fields_to_import()}
+     * @param int $courseid our local course id
+     * @return bool true if the enrolment has been successful, throws exception otherwise
+     */
+    public function enrol_user(array $userdata, $courseid) {
+        global $CFG, $DB;
+        require_once(__DIR__.'/lib.php');
+
+        if (!$client = get_mnet_remote_client()) {
+            die('Callable via XML-RPC only');
+        }
+
+        if (empty($userdata['username'])) {
+            throw new mnet_server_exception(5021, 'emptyusername', 'enrol_mnet');
+        }
+
+        // do we know the remote user?
+        $user = $DB->get_record('user', array('username'=>$userdata['username'], 'mnethostid'=>$client->id));
+
+        if ($user === false) {
+            // here we could check the setting if the enrol_mnet is allowed to auto-register
+            // users {@link http://tracker.moodle.org/browse/MDL-21327}
+            $user = mnet_strip_user((object)$userdata, mnet_fields_to_import($client));
+            $user->mnethostid = $client->id;
+            $user->auth = 'mnet';
+            $user->confirmed = 1;
+            try {
+                $user->id = $DB->insert_record('user', $user);
+            } catch (Exception $e) {
+                throw new mnet_server_exception(5011, 'couldnotcreateuser', 'enrol_mnet');
+            }
+        }
+
+        if (! $course = $DB->get_record('course', array('id'=>$courseid))) {
+            throw new mnet_server_exception(5012, 'coursenotfound', 'enrol_mnet');
+        }
+
+        $courses = $this->available_courses();
+        $isavailable = false;
+        foreach ($courses as $available) {
+            if ($available->remoteid == $course->id) {
+                $isavailable = true;
+                break;
+            }
+        }
+        if (!$isavailable) {
+            throw new mnet_server_exception(5013, 'courseunavailable', 'enrol_mnet');
+        }
+
+        // try to load host specific enrol_mnet instance first
+        $instance = $DB->get_record('enrol', array('courseid'=>$course->id, 'enrol'=>'mnet', 'customint1'=>$client->id), '*', IGNORE_MISSING);
+
+        if ($instance === false) {
+            // if not found, try to load instance for all hosts
+            $instance = $DB->get_record('enrol', array('courseid'=>$course->id, 'enrol'=>'mnet', 'customint1'=>0), '*', IGNORE_MISSING);
+        }
+
+        if ($instance === false) {
+            // this should not happen as the course was returned by {@see self::available_courses()}
+            throw new mnet_server_exception(5017, 'noenrolinstance', 'enrol_mnet');
+        }
+
+        if (!$enrol = enrol_get_plugin('mnet')) {
+            throw new mnet_server_exception(5018, 'couldnotinstantiate', 'enrol_mnet');
+        }
+
+        try {
+            $enrol->enrol_user($instance, $user->id, $instance->roleid, time());
+
+        } catch (Exception $e) {
+            throw new mnet_server_exception(5019, 'couldnotenrol', 'enrol_mnet', $e->getMessage());
+        }
+
+        return true;
+    }
+
+    /**
+     * Unenrol remote user from our course
+     *
+     * Only users enrolled via enrol_mnet plugin can be unenrolled remotely. If the
+     * remote user is enrolled into the local course via some other enrol plugin
+     * (enrol_manual for example), the remote host can't touch such enrolment. Please
+     * do not report this behaviour as bug, it is a feature ;-)
+     *
+     * @uses mnet_remote_client Callable via XML-RPC only
+     * @param string $username of the remote user
+     * @param int $courseid of our local course
+     * @return bool true if the unenrolment has been successful, throws exception otherwise
+     */
+    public function unenrol_user($username, $courseid) {
+        global $CFG, $DB;
+
+        if (!$client = get_mnet_remote_client()) {
+            die('Callable via XML-RPC only');
+        }
+
+        $user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$client->id));
+
+        if ($user === false) {
+            throw new mnet_server_exception(5014, 'usernotfound', 'enrol_mnet');
+        }
+
+        if (! $course = $DB->get_record('course', array('id'=>$courseid))) {
+            throw new mnet_server_exception(5012, 'coursenotfound', 'enrol_mnet');
+        }
+
+        $courses = $this->available_courses();
+        $isavailable = false;
+        foreach ($courses as $available) {
+            if ($available->remoteid == $course->id) {
+                $isavailable = true;
+                break;
+            }
+        }
+        if (!$isavailable) {
+            // if they can not enrol, they can not unenrol
+            throw new mnet_server_exception(5013, 'courseunavailable', 'enrol_mnet');
+        }
+
+        // try to load host specific enrol_mnet instance first
+        $instance = $DB->get_record('enrol', array('courseid'=>$course->id, 'enrol'=>'mnet', 'customint1'=>$client->id), '*', IGNORE_MISSING);
+
+        if ($instance === false) {
+            // if not found, try to load instance for all hosts
+            $instance = $DB->get_record('enrol', array('courseid'=>$course->id, 'enrol'=>'mnet', 'customint1'=>0), '*', IGNORE_MISSING);
+            $instanceforall = true;
+        }
+
+        if ($instance === false) {
+            // this should not happen as the course was returned by {@see self::available_courses()}
+            throw new mnet_server_exception(5017, 'noenrolinstance', 'enrol_mnet');
+        }
+
+        if (!$enrol = enrol_get_plugin('mnet')) {
+            throw new mnet_server_exception(5018, 'couldnotinstantiate', 'enrol_mnet');
+        }
+
+        if ($DB->record_exists('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$user->id))) {
+            try {
+                $enrol->unenrol_user($instance, $user->id);
+
+            } catch (Exception $e) {
+                throw new mnet_server_exception(5020, 'couldnotunenrol', 'enrol_mnet', $e->getMessage());
+            }
+        }
+
+        if (empty($instanceforall)) {
+            // if the user was enrolled via 'All hosts' instance and the specific one
+            // was created after that, the first enrolment would be kept.
+            $instance = $DB->get_record('enrol', array('courseid'=>$course->id, 'enrol'=>'mnet', 'customint1'=>0), '*', IGNORE_MISSING);
+
+            if ($instance) {
+                // repeat the same procedure for 'All hosts' instance, too. Note that as the host specific
+                // instance exists, it will be used for the future enrolments
+
+                if ($DB->record_exists('user_enrolments', array('enrolid'=>$instance->id, 'userid'=>$user->id))) {
+                    try {
+                        $enrol->unenrol_user($instance, $user->id);
+
+                    } catch (Exception $e) {
+                        throw new mnet_server_exception(5020, 'couldnotunenrol', 'enrol_mnet', $e->getMessage());
+                    }
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns a list of users from the client server who are enrolled in our course
+     *
+     * Suitable instance of enrol_mnet must be created in the course. This method will not
+     * return any information about the enrolments in courses that are not available for
+     * remote enrolment, even if their users are enrolled into them via other plugin
+     * (note the difference from {@link self::user_enrolments()}).
+     *
+     * This method will return enrolment information for users from hosts regardless
+     * the enrolment plugin. It does not matter if the user was enrolled remotely by
+     * their admin or locally. Once the course is available for remote enrolments, we
+     * will tell them everything about their users.
+     *
+     * In Moodle 1.x the returned array used to be indexed by username. The side effect
+     * of MDL-19219 fix is that we do not need to use such index and therefore we can
+     * return all enrolment records. MNet clients 1.x will only use the last record for
+     * the student, if she is enrolled via multiple plugins.
+     *
+     * @uses mnet_remote_client Callable via XML-RPC only
+     * @param int $courseid ID of our course
+     * @param string|array $roles comma separated list of role shortnames (or array of them)
+     * @return array
+     */
+    public function course_enrolments($courseid, $roles=null) {
+        global $DB, $CFG;
+
+        if (!$client = get_mnet_remote_client()) {
+            die('Callable via XML-RPC only');
+        }
+
+        $sql = "SELECT u.username, r.shortname, r.name, e.enrol, ue.timemodified
+                  FROM {user_enrolments} ue
+                  JOIN {user} u ON ue.userid = u.id
+                  JOIN {enrol} e ON ue.enrolid = e.id
+                  JOIN {role} r ON e.roleid = r.id
+                 WHERE u.mnethostid = :mnethostid
+                       AND e.courseid = :courseid
+                       AND u.id <> :guestid
+                       AND u.confirmed = 1
+                       AND u.deleted = 0";
+        $params['mnethostid'] = $client->id;
+        $params['courseid'] = $courseid;
+        $params['guestid'] = $CFG->siteguest;
+
+        if (!is_null($roles)) {
+            if (!is_array($roles)) {
+                $roles = explode(',', $roles);
+            }
+            $roles = array_map('trim', $roles);
+            list($rsql, $rparams) = $DB->get_in_or_equal($roles, SQL_PARAMS_NAMED);
+            $sql .= " AND r.shortname $rsql";
+            $params = array_merge($params, $rparams);
+        }
+
+        list($sort, $sortparams) = users_order_by_sql('u');
+        $sql .= " ORDER BY $sort";
+
+        $rs = $DB->get_recordset_sql($sql, array_merge($params, $sortparams));
+        $list = array();
+        foreach ($rs as $record) {
+            $list[] = $record;
+        }
+        $rs->close();
+
+        return $list;
+    }
+}

enrol/mnet/lang/en/enrol_mnet.php

@@ -0,0 +1,38 @@
+<?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/>.
+
+/**
+ * English strings for MNet enrolment plugin.
+ *
+ * @package    enrol_mnet
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['error_multiplehost'] = 'Some instance of MNet enrolment plugin already exists for this host. Only one instance per host and/or one instance for \'All hosts\' is allowed.';
+$string['instancename'] = 'Enrolment method name';
+$string['instancename_help'] = 'You can optionally rename this instance of the MNet enrolment method. If you leave this field empty, the default instance name will be used, containing the name of the remote host and the assigned role for their users.';
+$string['mnet:config'] = 'Configure MNet enrol instances';
+$string['mnet_enrol_description'] = 'Publish this service to allow administrators at {$a} to enrol their students in courses you have created on your server.<br/><ul><li><em>Dependency</em>: You must also <strong>subscribe</strong> to the SSO (Identity Provider) service on {$a}.</li><li><em>Dependency</em>: You must also <strong>publish</strong> the SSO (Service Provider) service to {$a}.</li></ul><br/>Subscribe to this service to be able to enrol your students in courses  on {$a}.<br/><ul><li><em>Dependency</em>: You must also <strong>publish</strong> the SSO (Identity Provider) service to {$a}.</li><li><em>Dependency</em>: You must also <strong>subscribe</strong> to the SSO (Service Provider) service on {$a}.</li></ul><br/>';
+$string['mnet_enrol_name'] = 'Remote enrolment service';
+$string['pluginname'] = 'MNet remote enrolments';
+$string['pluginname_desc'] = 'Allows remote MNet host to enrol their users into our courses.';
+$string['remotesubscriber'] = 'Remote host';
+$string['remotesubscriber_help'] = 'Select \'All hosts\' to open this course for all MNet peers we are offering the remote enrolment service to. Or choose a single host to make this course available for their users only.';
+$string['remotesubscribersall'] = 'All hosts';
+$string['roleforremoteusers'] = 'Role for their users';
+$string['roleforremoteusers_help'] = 'What role will the remote users from the selected host get.';
+$string['privacy:metadata'] = 'The MNet remote enrolments plugin does not store any personal data.';

enrol/mnet/lib.php

@@ -0,0 +1,213 @@
+<?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 enrolment plugin
+ *
+ * @package    enrol_mnet
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * MNet enrolment plugin implementation for Moodle 2.x enrolment framework
+ */
+class enrol_mnet_plugin extends enrol_plugin {
+
+    /**
+     * Returns localised name of enrol instance
+     *
+     * @param object|null $instance enrol_mnet instance
+     * @return string
+     */
+    public function get_instance_name($instance) {
+        global $DB;
+
+        if (empty($instance)) {
+            $enrol = $this->get_name();
+            return get_string('pluginname', 'enrol_'.$enrol);
+
+        } else if (empty($instance->name)) {
+            $enrol = $this->get_name();
+            if ($role = $DB->get_record('role', array('id'=>$instance->roleid))) {
+                $role = role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING));
+            } else {
+                $role = get_string('error');
+            }
+            if (empty($instance->customint1)) {
+                $host = get_string('remotesubscribersall', 'enrol_mnet');
+            } else {
+                $host = $DB->get_field('mnet_host', 'name', array('id'=>$instance->customint1));
+            }
+            return get_string('pluginname', 'enrol_'.$enrol) . ' (' . format_string($host) . ' - ' . $role .')';
+
+        } else {
+            return format_string($instance->name);
+        }
+    }
+
+    /**
+     * Returns true if a new instance can be added to this course.
+     *
+     * The link is returned only if there are some MNet peers that we publish enrolment service to.
+     *
+     * @param int $courseid id of the course to add the instance to
+     * @return boolean
+     */
+    public function can_add_instance($courseid) {
+        global $CFG, $DB;
+        require_once($CFG->dirroot.'/mnet/service/enrol/locallib.php');
+
+        $service = mnetservice_enrol::get_instance();
+        if (!$service->is_available()) {
+            return false;
+        }
+        $coursecontext = context_course::instance($courseid);
+        if (!has_capability('moodle/course:enrolconfig', $coursecontext)) {
+            return false;
+        }
+        $subscribers = $service->get_remote_subscribers();
+        if (empty($subscribers)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Is it possible to delete enrol instance via standard UI?
+     *
+     * @param stdClass $instance
+     * @return bool
+     */
+    public function can_delete_instance($instance) {
+        $context = context_course::instance($instance->courseid);
+        return has_capability('enrol/mnet:config', $context);
+    }
+
+    /**
+     * Is it possible to hide/show enrol instance via standard UI?
+     *
+     * @param stdClass $instance
+     * @return bool
+     */
+    public function can_hide_show_instance($instance) {
+        $context = context_course::instance($instance->courseid);
+        return has_capability('enrol/mnet:config', $context);
+    }
+
+    /**
+     * Return an array of valid options for the hosts property.
+     *
+     * @return array
+     */
+    protected function get_valid_hosts_options() {
+        global $CFG;
+        require_once($CFG->dirroot.'/mnet/service/enrol/locallib.php');
+
+        $service = mnetservice_enrol::get_instance();
+
+        $subscribers = $service->get_remote_subscribers();
+        $hosts = array(0 => get_string('remotesubscribersall', 'enrol_mnet'));
+        foreach ($subscribers as $hostid => $subscriber) {
+            $hosts[$hostid] = $subscriber->appname.': '.$subscriber->hostname.' ('.$subscriber->hosturl.')';
+        }
+        return $hosts;
+    }
+
+    /**
+     * Return an array of valid options for the roles property.
+     *
+     * @param context $context
+     * @return array
+     */
+    protected function get_valid_roles_options($context) {
+        $roles = get_assignable_roles($context);
+        return $roles;
+    }
+
+    /**
+     * Add elements to the edit instance form.
+     *
+     * @param stdClass $instance
+     * @param MoodleQuickForm $mform
+     * @param context $context
+     * @return bool
+     */
+    public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
+        global $CFG;
+
+        $hosts = $this->get_valid_hosts_options();
+        $mform->addElement('select', 'customint1', get_string('remotesubscriber', 'enrol_mnet'), $hosts);
+        $mform->addHelpButton('customint1', 'remotesubscriber', 'enrol_mnet');
+        $mform->addRule('customint1', get_string('required'), 'required', null, 'client');
+
+        $roles = $this->get_valid_roles_options($context);
+        $mform->addElement('select', 'roleid', get_string('roleforremoteusers', 'enrol_mnet'), $roles);
+        $mform->addHelpButton('roleid', 'roleforremoteusers', 'enrol_mnet');
+        $mform->addRule('roleid', get_string('required'), 'required', null, 'client');
+        $mform->setDefault('roleid', $this->get_config('roleid'));
+
+        $mform->addElement('text', 'name', get_string('instancename', 'enrol_mnet'));
+        $mform->addHelpButton('name', 'instancename', 'enrol_mnet');
+        $mform->setType('name', PARAM_TEXT);
+    }
+
+    /**
+     * We are a good plugin and don't invent our own UI/validation code path.
+     *
+     * @return boolean
+     */
+    public function use_standard_editing_ui() {
+        return true;
+    }
+
+    /**
+     * Perform custom validation of the data used to edit the instance.
+     *
+     * @param array $data array of ("fieldname"=>value) of submitted data
+     * @param array $files array of uploaded files "element_name"=>tmp_file_path
+     * @param object $instance The instance loaded from the DB
+     * @param context $context The context of the instance we are editing
+     * @return array of "element_name"=>"error_description" if there are errors,
+     *         or an empty array if everything is OK.
+     * @return void
+     */
+    public function edit_instance_validation($data, $files, $instance, $context) {
+        global $DB;
+        $errors = array();
+
+        $validroles = array_keys($this->get_valid_roles_options($context));
+        $validhosts = array_keys($this->get_valid_hosts_options());
+
+        $params = array('enrol' => 'mnet', 'courseid' => $instance->courseid, 'customint1' => $data['customint1']);
+        if ($DB->record_exists('enrol', $params)) {
+            $errors['customint1'] = get_string('error_multiplehost', 'enrol_mnet');
+        }
+
+        $tovalidate = array(
+            'customint1' => $validhosts,
+            'roleid' => $validroles,
+            'name' => PARAM_TEXT
+        );
+        $typeerrors = $this->validate_param_types($data, $tovalidate);
+        $errors = array_merge($errors, $typeerrors);
+
+        return $errors;
+    }
+}

enrol/mnet/settings.php

@@ -0,0 +1,41 @@
+<?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/>.
+
+/**
+ * Cohort enrolment plugin settings and default values
+ *
+ * @package    enrol_mnet
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+if ($ADMIN->fulltree) {
+
+    //--- general settings -----------------------------------------------------------------------------------
+    $settings->add(new admin_setting_heading('enrol_mnet_settings', '', get_string('pluginname_desc', 'enrol_mnet')));
+
+    //--- enrol instance defaults ----------------------------------------------------------------------------
+    if (!during_initial_install()) {
+        $options = get_default_enrol_roles(context_system::instance());
+        $student = get_archetype_roles('student');
+        $student = reset($student);
+        $settings->add(new admin_setting_configselect_with_advanced('enrol_mnet/roleid',
+            get_string('defaultrole', 'role'), '',
+            array('value' => $student->id ?? null, 'adv' => true), $options));
+    }
+}

enrol/mnet/version.php

@@ -0,0 +1,29 @@
+<?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 enrolment plugin version specification.
+ *
+ * @package    enrol_mnet
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;        // The current plugin version (Date: YYYYMMDDXX).
+$plugin->requires  = 2024041600;        // Requires this Moodle version.
+$plugin->component = 'enrol_mnet';      // Full name of the plugin (used for diagnostics)