Update auth plugins; allow them to not require login if it is not nec…

…essary; add Moodle prototype; default to Guest and no login is required

git-svn-id: https://xerteonlinetoolkits.googlecode.com/svn/trunk@317 912cdd6b-5c7d-d5a7-a2ba-d0f0cdb91641

config.php

@@ -64,7 +64,7 @@
      * @copyright 2008,2009 University of Nottingham
      */
     /**
-     * Include any script that is used for configuration
+     * Include any script that is used for configuration - for moodle this might be e.g. '/xampp/htdocs/moodle/config.php'.
      */
     if ($row['integration_config_path'] != "") {
         require_once($row['integration_config_path']);
@@ -141,8 +141,8 @@
     //$xerte_toolkits_site->authentication_method = 'Static';
     //$xerte_toolkits_site->authentication_method = "Moodle";
 
-    if(isset($_SESSION['integrate_with_moodle']) && $_SESSION['integrate_with_moodle'] == true) {
-        // skip session_start()
+    if($xerte_toolkits_site->authentication_method == "Moodle") {
+        // skip session_start() as we'll probably stomp on Moodle's session if we do. 
     }
     else {
         session_start();

library/Xerte/Authentication/Abstract.php

@@ -52,10 +52,24 @@ public function __construct($xerte_toolkits_site)
         $this->xerte_toolkits_site = $xerte_toolkits_site;
     }
 
+    /**
+     *@return string $username provided by the end user or the auth mechanism (e.g. Moodle session contents etc) 
+     */
+    abstract public function getUsername();
     /**
      * Perform some sort of check to ensure stuff is configured correctly.... e.g. for LDAP make sure the user has the 'ldap_connect' function available etc
      * If any errors are found; retrieve via getErrors();
      * @return boolean true
      */
     abstract public function check();
+
+    /**
+     *Change this to return FALSE in one of the other authenticators, and the end user shouldn't be shown the login box/dialogue - presumably
+     * because there's some sort of single sign on in place which we can test immediately without them needing to fill in a login box.
+     * 
+     * @return boolean true if they need to login.
+     */
+    public function needsLogin() {
+        return true;
+    }
 }

library/Xerte/Authentication/Db.php

@@ -21,7 +21,15 @@ public function getFirstname()
         }
         return null;
     }
+    public function getUsername()
+    {
+        if (isset($this->_record['username'])) {
+            return $this->_record['username'];
+        }
+        return null;
+    }
 
+
     public function getSurname()
     {
         if (isset($this->_record['surname'])) {

library/Xerte/Authentication/Guest.php

@@ -10,6 +10,10 @@ class Xerte_Authentication_Guest extends Xerte_Authentication_Abstract
     private $_record = array();
 
 
+    public function getUsername() {
+        return 'guest';
+    }
+
     public function getFirstname()
     {
         return "Guest";
@@ -29,5 +33,8 @@ public function login($username, $password)
     {
        return true;
     }
+    public function needsLogin() {
+        return false;
+    }
 
 }

library/Xerte/Authentication/Ldap.php

@@ -18,6 +18,12 @@ class Xerte_Authentication_Ldap extends Xerte_Authentication_Abstract
 
     private $_record = array();
 
+    public function getUsername() {
+        if(isset($this->_record['username'])) {
+            return $this->_record['username'];
+        }
+        return null;
+    }
     public function getFirstname()
     {
         if (isset($this->_record['fn'])) {
@@ -144,7 +150,7 @@ private function _authenticate_to_host($host, $port, $bind_pwd, $bind_dn, $based
                          * valid login, so return true
                          */
 
-                        $this->_record = array('firstname' => $entry[0]['givenname'][0], 'surname' => $entry[0]['sn'][0]);
+                        $this->_record = array('firstname' => $entry[0]['givenname'][0], 'surname' => $entry[0]['sn'][0], 'username' => $eureka_username);
                         return true;
                     }
                 }
@@ -168,6 +174,7 @@ private function _authenticate_to_host($host, $port, $bind_pwd, $bind_dn, $based
                         $entry = @ldap_get_entries($ldapConnection, $ldapSearchResult);
                         if (!empty($entry)) {
                             $this->_record = $entry;
+                            $this->_record['username'] = $eureka_username;
                             return true;
                         }
                     }

library/Xerte/Authentication/Moodle.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * Always returns true; ideal for demonstration so someone can just click the 'login' button.
+ *  
+ */
+class Xerte_Authentication_Moodle extends Xerte_Authentication_Abstract
+{
+    /* @var $_record array - contains the current user's details - expects keys like firstname, surname */
+
+    private $_record = null;
+
+    public function getUsername()
+    {
+        return $this->_record->username;
+    }
+
+    public function getFirstname()
+    {
+        return $this->_record->firstname;
+    }
+
+    public function getSurname()
+    {
+        return $this->_record->lastname;
+    }
+
+    public function check()
+    {
+        if (!isset($_SESSION['integrate_with_moodle'])) {
+            $this->addError("Moodle integration not enabled");
+        }
+    }
+
+    /** Moodle integration should result in us having some funky stuff enabled magically ... */
+    public function needsLogin()
+    {
+        global $USER;
+        if (empty($USER)) {
+            return true;
+        }
+        $this->_record = $USER;
+        require_login(); /// moodle function - should shunt the user over to a login page for Moodle if it's needed. Hopefully there are no scope issues from calling it here in a function.
+        return false;
+    }
+
+    public function login($username, $password)
+    {
+        return true;
+    }
+
+}
+

library/Xerte/Authentication/Static.php

@@ -18,6 +18,9 @@ class Xerte_Authentication_Static extends Xerte_Authentication_Abstract
         'sarah' => array("username" => "sarah", "password" => "sarahpassword", "firstname" => "Sarah", "surname" => "smith"),
     );
 
+    public function getUsername() {
+        return $this->_record['username'];
+    }
     public function getFirstname()
     {
         return $this->_record['firstname'];