auth/pop3/auth.php

   1 <?php
   2
   3 /**
   4  * @author Martin Dougiamas
   5  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
   6  * @package moodle multiauth
   7  *
   8  * Authentication Plugin: POP3 Authentication
   9  *
  10  * Authenticates against a POP3 server.
  11  *
  12  * 2006-08-31  File created.
  13  */
  14
  15 if (!defined('MOODLE_INTERNAL')) {
  16     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  17 }
  18
  19 /**
  20  * POP3 authentication plugin.
  21  */
  22 class auth_plugin_pop3 {
  23
  24     /**
  25      * The configuration details for the plugin.
  26      */
  27     var $config;
  28
  29     /**
  30      * Constructor.
  31      */
  32     function auth_plugin_pop3() {
  33         $this->config = get_config('auth/pop3');
  34     }
  35
  36     /**
  37      * Returns true if the username and password work and false if they are
  38      * wrong or don't exist.
  39      *
  40      * @param string $username The username (with system magic quotes)
  41      * @param string $password The password (with system magic quotes)
  42      * @return bool Authentication success or failure.
  43      */
  44     function user_login($username, $password) {
  45         if (! function_exists('imap_open')) {
  46             print_error('auth_pop3notinstalled','auth');
  47             exit;
  48         }
  49
  50         global $CFG;
  51         $hosts = split(';', $this->config->host);   // Could be multiple hosts
  52         foreach ($hosts as $host) {                 // Try each host in turn
  53             $host = trim($host);
  54
  55             // remove any trailing slash
  56             if (substr($host, -1) == '/') {
  57                 $host = substr($host, 0, strlen($host) - 1);
  58             }
  59
  60             switch ($this->config->type) {
  61                 case 'pop3':
  62                     $host = '{'.$host.":{$this->config->port}/pop3}{$this->config->mailbox}";
  63                 break;
  64
  65                 case 'pop3notls':
  66                     $host = '{'.$host.":{$this->config->port}/pop3/notls}{$this->config->mailbox}";
  67                 break;
  68
  69                 case 'pop3cert':
  70                     $host = '{'.$host.":{$this->config->port}/pop3/ssl/novalidate-cert}{$this->config->mailbox}";
  71                 break;
  72             }
  73
  74             error_reporting(0);
  75             $connection = imap_open($host, stripslashes($username), stripslashes($password));
  76             error_reporting($CFG->debug);
  77
  78             if ($connection) {
  79                 imap_close($connection);
  80                 return true;
  81             }
  82         }
  83         return false;  // No matches found
  84     }
  85
  86     /**
  87      * Returns true if this authentication plugin is 'internal'.
  88      *
  89      * @return bool
  90      */
  91     function is_internal() {
  92         return false;
  93     }
  94
  95     /**
  96      * Returns true if this authentication plugin can change the user's
  97      * password.
  98      *
  99      * @return bool
 100      */
 101     function can_change_password() {
 102         return !empty($this->config->changepasswordurl);
 103     }
 104
 105     /**
 106      * Returns the URL for changing the user's pw, or false if the default can
 107      * be used.
 108      *
 109      * @return bool
 110      */
 111     function change_password_url() {
 112         return $this->config->changepasswordurl;
 113     }
 114
 115     /**
 116      * Prints a form for configuring this authentication plugin.
 117      *
 118      * This function is called from admin/auth.php, and outputs a full page with
 119      * a form for configuring this plugin.
 120      *
 121      * @param array $page An object containing all the data for this page.
 122      */
 123     function config_form($config, $err, $user_fields) {
 124         include "config.html";
 125     }
 126
 127     /**
 128      * Processes and stores configuration data for this authentication plugin.
 129      */
 130     function process_config($config) {
 131         // set to defaults if undefined
 132         if (!isset ($config->host)) {
 133             $config->host = '127.0.0.1';
 134         }
 135         if (!isset ($config->type)) {
 136             $config->type = 'pop3notls';
 137         }
 138         if (!isset ($config->port)) {
 139             $config->port = '143';
 140         }
 141         if (!isset ($config->mailbox)) {
 142             $config->mailbox = 'INBOX';
 143         }
 144         if (!isset($config->changepasswordurl)) {
 145             $config->changepasswordurl = '';
 146         }
 147
 148         // save settings
 149         set_config('host',    $config->host,    'auth/pop3');
 150         set_config('type',    $config->type,    'auth/pop3');
 151         set_config('port',    $config->port,    'auth/pop3');
 152         set_config('mailbox', $config->mailbox, 'auth/pop3');
 153         set_config('changepasswordurl', $config->changepasswordurl, 'auth/pop3');
 154
 155         return true;
 156     }
 157
 158 }
 159
 160 ?>