multiauth: migrated all files to the new OO API, written new API documentation

Author: Martin Langhoff <[email protected]>
2007-01-04 04:52:42 +00:00
parent d7275959a6
commit b9ddb2d5ea
52 changed files with 5366 additions and 3396 deletions
@@ -0,0 +1,155 @@
+<?php
+
+/**
+ * @author Martin Dougiamas
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package moodle multiauth
+ *
+ * Authentication Plugin: IMAP Authentication
+ *
+ * Authenticates against an IMAP server.
+ *
+ * 2006-08-31  File created.
+ */
+
+// This page cannot be called directly
+if (!isset($CFG)) exit;
+
+/**
+ * IMAP authentication plugin.
+ */
+class auth_plugin_imap {
+
+    /**
+     * The configuration details for the plugin.
+     */
+    var $config;
+
+    /**
+     * Constructor.
+     */
+    function auth_plugin_imap() {
+        $this->config = get_config('auth/imap');
+    }
+
+    /**
+     * 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
+     * @returns bool Authentication success or failure.
+     */
+    function user_login ($username, $password) {
+        if (! function_exists('imap_open')) {
+            error("Cannot use IMAP authentication. The PHP IMAP module is not installed.");
+        }
+        
+        global $CFG;
+        $hosts = split(';', $this->config->host);   // Could be multiple hosts
+
+        foreach ($hosts as $host) {                 // Try each host in turn
+            $host = trim($host);
+
+            switch ($this->config->type) {
+                case 'imapssl':
+                    $host = '{'.$host.":{$this->config->port}/imap/ssl}";
+                break;
+        
+                case 'imapcert':
+                    $host = '{'.$host.":{$this->config->port}/imap/ssl/novalidate-cert}";
+                break;
+        
+                case 'imaptls':
+                    $host = '{'.$host.":{$this->config->port}/imap/tls}";
+                break;
+        
+                default:
+                    $host = '{'.$host.":{$this->config->port}/imap}";
+            }
+
+            error_reporting(0);
+            $connection = imap_open($host, $username, $password, OP_HALFOPEN);
+            error_reporting($CFG->debug);   
+
+            if ($connection) {
+                imap_close($connection);
+                return true;
+            }
+        }
+
+        return false;  // No match
+    }
+
+    /**
+     * Returns true if this authentication plugin is 'internal'.
+     *
+     * @returns bool
+     */
+    function is_internal() {
+        return false;
+    }
+
+    /**
+     * Returns true if this authentication plugin can change the user's
+     * password.
+     *
+     * @returns bool
+     */
+    function can_change_password() {
+        return false;
+    }
+    
+    /**
+     * Returns the URL for changing the user's pw, or false if the default can
+     * be used.
+     *
+     * @returns bool
+     */
+    function change_password_url() {
+        return $CFG->changepasswordurl; // TODO: will this be global?
+        //return $this->config->changepasswordurl;
+    }
+    
+    /**
+     * Prints a form for configuring this authentication plugin.
+     *
+     * This function is called from admin/auth.php, and outputs a full page with
+     * a form for configuring this plugin.
+     *
+     * @param array $page An object containing all the data for this page.
+     */
+    function config_form($config, $err) {
+        include "config.html";
+    }
+
+    /**
+     * Processes and stores configuration data for this authentication plugin.
+     */
+    function process_config($config) {
+        // set to defaults if undefined
+        if (!isset ($config->host)) {
+            $config->host = '127.0.0.1';
+        }
+        if (!isset ($config->type)) {
+            $config->type = 'imap';
+        }
+        if (!isset ($config->port)) {
+            $config->port = '143';
+        }
+        if (!isset($config->changepasswordurl)) {
+            $config->changepasswordurl = '';
+        }
+
+        // save settings
+        set_config('host', $config->host, 'auth/imap');
+        set_config('type', $config->type, 'auth/imap');
+        set_config('port', $config->port, 'auth/imap');
+        set_config('changepasswordurl', $config->changepasswordurl, 'auth/imap');
+
+        return true;
+    }
+
+}
+
+?>