MDL-50925 auth_nntp: Remove from core and into plugins DB
authorAndrew Nicols <andrew@nicols.co.uk>
Thu, 13 Jul 2017 07:29:16 +0000 (15:29 +0800)
committerAndrew Nicols <andrew@nicols.co.uk>
Tue, 18 Jul 2017 06:48:23 +0000 (14:48 +0800)
auth/README.txt
auth/nntp/auth.php [deleted file]
auth/nntp/db/install.php [deleted file]
auth/nntp/db/upgrade.php [deleted file]
auth/nntp/lang/en/auth_nntp.php [deleted file]
auth/nntp/settings.php [deleted file]
auth/nntp/upgrade.txt [deleted file]
auth/nntp/version.php [deleted file]
lib/classes/plugin_manager.php

index 48337b4..1cbe2ec 100644 (file)
@@ -78,15 +78,6 @@ pop3  - Uses an external POP3 server
       a new account is created
 
 
-nntp  - Uses an external NNTP server
-
-    - user logs in using username and password
-    - these are checked against an NNTP server
-    - if correct, user is logged in
-    - if the username doesn't already exist then
-      a new account is created
-
-
 db  - Uses an external database to check username/password
 
     - user logs in using username and password
diff --git a/auth/nntp/auth.php b/auth/nntp/auth.php
deleted file mode 100644 (file)
index 2ee31dc..0000000
+++ /dev/null
@@ -1,111 +0,0 @@
-<?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/>.
-
-/**
- * Authentication Plugin: NNTP Authentication
- * Authenticates against an NNTP server.
- *
- * @package auth_nntp
- * @author Martin Dougiamas
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->libdir.'/authlib.php');
-
-/**
- * NNTP authentication plugin.
- */
-class auth_plugin_nntp extends auth_plugin_base {
-
-    /**
-     * Constructor.
-     */
-    public function __construct() {
-        $this->authtype = 'nntp';
-        $this->config = get_config('auth_nntp');
-    }
-
-    /**
-     * Old syntax of class constructor. Deprecated in PHP7.
-     *
-     * @deprecated since Moodle 3.1
-     */
-    public function auth_plugin_nntp() {
-        debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
-        self::__construct();
-    }
-
-    /**
-     * Returns true if the username and password work and false if they are
-     * wrong or don't exist.
-     *
-     * @param string $username The username
-     * @param string $password The password
-     * @return bool Authentication success or failure.
-     */
-    function user_login ($username, $password) {
-        if (! function_exists('imap_open')) {
-            print_error('auth_nntpnotinstalled','auth_nntp');
-            exit;
-        }
-
-        global $CFG;
-
-        // try each multiple host
-        $hosts = explode(';', $this->config->host);
-        foreach ($hosts as $host) {
-            $host = '{' . trim($host) . ':' . $this->config->port . '/nntp}';
-
-            error_reporting(0);
-            $connection = imap_open($host, $username, $password, OP_HALFOPEN);
-            error_reporting($CFG->debug);
-
-            if ($connection) {
-                imap_close($connection);
-                return true;
-            }
-        }
-        return false;
-    }
-
-    function prevent_local_passwords() {
-        return true;
-    }
-
-    /**
-     * Returns true if this authentication plugin is 'internal'.
-     *
-     * @return bool
-     */
-    function is_internal() {
-        return false;
-    }
-
-    /**
-     * Returns true if this authentication plugin can change the user's
-     * password.
-     *
-     * @return bool
-     */
-    function can_change_password() {
-        return false;
-    }
-
-}
-
-
diff --git a/auth/nntp/db/install.php b/auth/nntp/db/install.php
deleted file mode 100644 (file)
index 18d66b9..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-<?php
-
-function xmldb_auth_nntp_install() {
-    global $CFG, $DB;
-
-}
diff --git a/auth/nntp/db/upgrade.php b/auth/nntp/db/upgrade.php
deleted file mode 100644 (file)
index bd869bc..0000000
+++ /dev/null
@@ -1,49 +0,0 @@
-<?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/>.
-
-/**
- * NNTP authentication plugin upgrade code
- *
- * @package    auth_nntp
- * @copyright  2017 Stephen Bourget
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-/**
- * Function to upgrade auth_nntp.
- * @param int $oldversion the version we are upgrading from
- * @return bool result
- */
-function xmldb_auth_nntp_upgrade($oldversion) {
-    global $CFG, $DB;
-
-    // Automatically generated Moodle v3.2.0 release upgrade line.
-    // Put any upgrade step following this.
-
-    if ($oldversion < 2017020700) {
-        // Convert info in config plugins from auth/nntp to auth_nntp.
-        upgrade_fix_config_auth_plugin_names('nntp');
-        upgrade_fix_config_auth_plugin_defaults('nntp');
-        upgrade_plugin_savepoint(true, 2017020700, 'auth', 'nntp');
-    }
-
-    // Automatically generated Moodle v3.3.0 release upgrade line.
-    // Put any upgrade step following this.
-
-    return true;
-}
diff --git a/auth/nntp/lang/en/auth_nntp.php b/auth/nntp/lang/en/auth_nntp.php
deleted file mode 100644 (file)
index fa10cac..0000000
+++ /dev/null
@@ -1,32 +0,0 @@
-<?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/>.
-
-/**
- * Strings for component 'auth_nntp', language 'en'.
- *
- * @package   auth_nntp
- * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-$string['auth_nntpdescription'] = 'This method uses an NNTP server to check whether a given username and password is valid.';
-$string['auth_nntphost'] = 'The NNTP server address. Use the IP number, not DNS name.';
-$string['auth_nntphost_key'] = 'Host';
-$string['auth_nntpchangepasswordurl_key'] = 'Password-change URL';
-$string['auth_nntpnotinstalled'] = 'Cannot use NNTP authentication. The PHP IMAP module is not installed.';
-$string['auth_nntpport'] = 'Server port (119 is the most common)';
-$string['auth_nntpport_key'] = 'Port';
-$string['pluginname'] = 'NNTP server';
diff --git a/auth/nntp/settings.php b/auth/nntp/settings.php
deleted file mode 100644 (file)
index bf475ee..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-<?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/>.
-
-/**
- * Admin settings and defaults.
- *
- * @package    auth_nntp
- * @copyright  2017 Stephen Bourget
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die;
-
-if ($ADMIN->fulltree) {
-
-    // Introductory explanation.
-    $settings->add(new admin_setting_heading('auth_nntp/pluginname', '', new lang_string('auth_nntpdescription', 'auth_nntp')));
-
-    // Host.
-    $settings->add(new admin_setting_configtext('auth_nntp/host', get_string('auth_nntphost_key', 'auth_nntp'),
-            get_string('auth_nntphost', 'auth_nntp') . ' ' .get_string('auth_multiplehosts', 'auth'),
-            '127.0.0.1', PARAM_RAW));
-
-    // Port.
-    $settings->add(new admin_setting_configtext('auth_nntp/port', get_string('auth_nntpport_key', 'auth_nntp'),
-            get_string('auth_nntpport', 'auth_nntp'), '119', PARAM_INT));
-
-    // Password change URL.
-    $settings->add(new admin_setting_configtext('auth_nntp/changepasswordurl',
-            get_string('auth_nntpchangepasswordurl_key', 'auth_nntp'),
-            get_string('changepasswordhelp', 'auth'), '', PARAM_URL));
-
-    // Display locking / mapping of profile fields.
-    $authplugin = get_auth_plugin('nntp');
-    display_auth_lock_options($settings, $authplugin->authtype, $authplugin->userfields,
-            get_string('auth_fieldlocks_help', 'auth'), false, false);
-}
diff --git a/auth/nntp/upgrade.txt b/auth/nntp/upgrade.txt
deleted file mode 100644 (file)
index 18376af..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-This files describes API changes in /auth/nntp/*,
-information provided here is intended especially for developers.
-
-=== 3.3 ===
-
-* The config.html file was migrated to use the admin settings API.
-  The identifier for configuration data stored in config_plugins table was converted from 'auth/nntp' to 'auth_nntp'.
diff --git a/auth/nntp/version.php b/auth/nntp/version.php
deleted file mode 100644 (file)
index 4ee22dc..0000000
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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/>.
-
-/**
- * Version information
- *
- * @package    auth_nntp
- * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-defined('MOODLE_INTERNAL') || die();
-
-$plugin->version   = 2017051500;        // The current plugin version (Date: YYYYMMDDXX)
-$plugin->requires  = 2017050500;        // Requires this Moodle version
-$plugin->component = 'auth_nntp';       // Full name of the plugin (used for diagnostics)
index 817678e..89c9525 100644 (file)
@@ -1646,7 +1646,7 @@ class core_plugin_manager {
         // Moodle 2.3 supports upgrades from 2.2.x only.
         $plugins = array(
             'qformat' => array('blackboard', 'learnwise'),
-            'auth' => array('radius', 'fc'),
+            'auth' => array('radius', 'fc', 'nntp'),
             'block' => array('course_overview'),
             'enrol' => array('authorize'),
             'report' => array('search'),
@@ -1702,7 +1702,7 @@ class core_plugin_manager {
 
             'auth' => array(
                 'cas', 'db', 'email', 'imap', 'ldap', 'lti', 'manual', 'mnet',
-                'nntp', 'nologin', 'none', 'oauth2', 'pam', 'pop3', 'shibboleth', 'webservice'
+                'nologin', 'none', 'oauth2', 'pam', 'pop3', 'shibboleth', 'webservice'
             ),
 
             'availability' => array(