Changeset 994 for trunk/wifidog-auth/wifidog/classes/Authenticator.php

Timestamp:

03/16/06 18:47:35 (7 years ago)

Author:

max-horvath

Message:

"2006-03-16 Max Horvath <max.horvath@…>

• updated language files (new german strings have already been translated)
• added LDAP authentication
• Dependencies class can check for an PHP extension now
• Dependencies class can check for multiple files on a single dependency now
• Authentication classes moved to it's own directory
• The getAuthenticator method now uses the much safer and faster call_user_func_array function to return an authenticator object
• the available authenticator classes are now being displayed in a select box on the network administration page
• the link to and the Google hotspots map as is won't be shown to an unauthenticated user at a real hotspot"

Files:

• trunk/wifidog-auth/wifidog/classes/Authenticator.php (modified) (9 diffs)

trunk/wifidog-auth/wifidog/classes/Authenticator.php

@@ -38 +38 @@
  * @subpackage Authenticators
  * @author     Benoit Gregoire <bock@step.polymtl.ca>
+ * @author     Max Horvath <max.horvath@maxspot.de>
  * @copyright  2005-2006 Benoit Gregoire, Technologies Coeus inc.
+ * @copyright  2006 Max Horvath, maxspot GmbH
  * @version    Subversion $Id$
  * @link       http://www.wifidog.org/
@@ -47 +49 @@
  */
 require_once('classes/Network.php');
+require_once('classes/Node.php');
 require_once('classes/Session.php');
+require_once('classes/User.php');
 
 /**
@@ -55 +59 @@
  * @subpackage Authenticators
  * @author     Benoit Gregoire <bock@step.polymtl.ca>
+ * @author     Max Horvath <max.horvath@maxspot.de>
  * @copyright  2005-2006 Benoit Gregoire, Technologies Coeus inc.
+ * @copyright  2006 Max Horvath, maxspot GmbH
  */
 abstract class Authenticator
 {
+    /**
+     * Object of current network
+     *
+     * @var object
+     *
+     * @access private
+     */
     private $mNetwork;
 
-    function __construct($network_id)
+    /**
+     * Constructor
+     *
+     * @param string $network_id Id of network
+     *
+     * @return void
+     *
+     * @access public
+     */
+    public function __construct($network_id)
     {
         $this->mNetwork = Network::getObject($network_id);
     }
 
+    /**
+     * Returns object of current network
+     *
+     * @return object Object of current network
+     *
+     * @access public
+     */
     public function getNetwork()
     {
@@ -71 +100 @@
     }
 
-    /** Attempts to login a user against the authentication source.  If successfull, returns a User object */
-    function login()
-    {
-    }
-
-    /** Logs out the user
-     * $conn_id:  The connection id for the connection to work on.  Optionnal.
-     *  If  it is not present, the behaviour depends if the network supports
-     * multiple logins.  If it does not, all connections associated with the
-     * current user will be destroyed.  If it does, only the connections
-     * tied to the current node will be destroyed */
-    function logout($conn_id = null)
+    /**
+     * Attempts to login a user against the authentication source
+     *
+     * If successfull, returns a User object.
+     *
+     * @access public
+     */
+    public function login()
+    {
+        // Must be defined in child class
+    }
+
+    /**
+     * Logs out the user
+     *
+     * @param string $conn_id The connection id for the connection to work on.
+     *                        If  it is not present, the behaviour depends if
+     *                        the network supports multiple logins. If it does
+     *                        not, all connections associated with the current
+     *                        user will be destroyed. If it does, only the
+     *                        connections tied to the current node will be
+     *                        destroyed.
+     *
+     * @return void
+     *
+     * @access public
+     */
+    public function logout($conn_id = null)
     {
         // Define globals
@@ -89 +134 @@
 
         $conn_id = $db->escapeString($conn_id);
-        if (!empty ($conn_id))
-        {
+
+        if (!empty ($conn_id)) {
             $db->execSqlUniqueRes("SELECT NOW(), *, CASE WHEN ((NOW() - reg_date) > networks.validation_grace_time) THEN true ELSE false END AS validation_grace_time_expired FROM connections JOIN users ON (users.user_id=connections.user_id) JOIN networks ON (users.account_origin = networks.network_id) WHERE connections.conn_id='$conn_id'", $info, false);
 
-            $user = User :: getObject($info['user_id']);
+            $user = User::getObject($info['user_id']);
             $network = $user->getNetwork();
             $splash_user_id = $network->getSplashOnlyUser()->getId();
             $this->acctStop($conn_id);
-        }
-        else
-        {
-            $user = User :: getCurrentUser();
+        } else {
+            $user = User::getCurrentUser();
             $network = $user->getNetwork();
             $splash_user_id = $network->getSplashOnlyUser()->getId();
-            if ($splash_user_id != $user->getId() && $node = Node :: getCurrentNode())
-            {
-                //Try to destroy all connections tied to the current node
-                $sql = "SELECT conn_id FROM connections WHERE user_id = '{$user->getId()}' AND node_id='{$node->getId()}' AND token_status='".TOKEN_INUSE."';\n";
+
+            if ($splash_user_id != $user->getId() && $node = Node::getCurrentNode()) {
+                // Try to destroy all connections tied to the current node
+                $sql = "SELECT conn_id FROM connections WHERE user_id = '{$user->getId()}' AND node_id='{$node->getId()}' AND token_status='".TOKEN_INUSE."';";
                 $conn_rows = null;
                 $db->execSql($sql, $conn_rows, false);
-                if ($conn_rows)
-                {
-                    foreach ($conn_rows as $conn_row)
-                    {
+
+                if ($conn_rows) {
+                    foreach ($conn_rows as $conn_row) {
                         $this->acctStop($conn_row['conn_id']);
                     }
@@ -119 +161 @@
         }
 
-        if ($splash_user_id != $user->getId() && $network->getMultipleLoginAllowed() == false)
-        {
-            /* The user isn't the splash_only user and the network config does not allow multiple logins.
-             * Logging in with a new token implies that all other active tokens should expire */
-            $sql = "SELECT conn_id FROM connections WHERE user_id = '{$user->getId()}' AND token_status='".TOKEN_INUSE."';\n";
+        if ($splash_user_id != $user->getId() && $network->getMultipleLoginAllowed() === false) {
+            /*
+             * The user isn't the splash_only user and the network config does
+             * not allow multiple logins. Logging in with a new token implies
+             * that all other active tokens should expire
+             */
+            $sql = "SELECT conn_id FROM connections WHERE user_id = '{$user->getId()}' AND token_status='".TOKEN_INUSE."';";
             $conn_rows = null;
             $db->execSql($sql, $conn_rows, false);
-            if ($conn_rows)
-            {
-                foreach ($conn_rows as $conn_row)
-                {
+
+            if ($conn_rows) {
+                foreach ($conn_rows as $conn_row) {
                     $this->acctStop($conn_row['conn_id']);
                 }
@@ -141 +184 @@
     }
 
-    /** Start accounting traffic for the user
-     * $conn_id:  The connection id for the connection to work on */
-    function acctStart($conn_id)
-    {
+    /**
+     * Start accounting traffic for the user
+     *
+     * @param string $conn_id The connection id for the connection to work on
+     *
+     * @return void
+     *
+     * @access public
+     */
+    public function acctStart($conn_id)
+    {
+        // Define globals
         global $db;
+
         $conn_id = $db->escapeString($conn_id);
         $db->execSqlUniqueRes("SELECT NOW(), *, CASE WHEN ((NOW() - reg_date) > networks.validation_grace_time) THEN true ELSE false END AS validation_grace_time_expired FROM connections JOIN users ON (users.user_id=connections.user_id) JOIN networks ON (users.account_origin = networks.network_id) WHERE connections.conn_id='$conn_id'", $info, false);
-        $network = Network :: getObject($info['network_id']);
+        $network = Network::getObject($info['network_id']);
         $splash_user_id = $network->getSplashOnlyUser()->getId();
         $auth_response = $info['account_status'];
-        /* Login the user */
+
+        // Login the user
         $mac = $db->escapeString($_REQUEST['mac']);
         $ip = $db->escapeString($_REQUEST['ip']);
-        $sql = "UPDATE connections SET "."token_status='".TOKEN_INUSE."',"."user_mac='$mac',"."user_ip='$ip',"."last_updated=NOW()"."WHERE conn_id='{$conn_id}';\n";
+        $sql = "UPDATE connections SET "."token_status='".TOKEN_INUSE."',"."user_mac='$mac',"."user_ip='$ip',"."last_updated=NOW()"."WHERE conn_id='{$conn_id}';";
         $db->execSqlUpdate($sql, false);
-        if ($splash_user_id != $info['user_id'] && $network->getMultipleLoginAllowed() == false)
-        {
-            /* The user isn't the splash_only user and the network config does not allow multiple logins.
-             * Logging in with a new token implies that all other active tokens should expire */
+
+        if ($splash_user_id != $info['user_id'] && $network->getMultipleLoginAllowed() === false) {
+            /*
+             * The user isn't the splash_only user and the network config does
+             * not allow multiple logins. Logging in with a new token implies
+             * that all other active tokens should expire
+             */
             $token = $db->escapeString($_REQUEST['token']);
-            $sql = "SELECT * FROM connections WHERE user_id = '{$info['user_id']}' AND token_status='".TOKEN_INUSE."' AND token!='$token';\n";
+            $sql = "SELECT * FROM connections WHERE user_id = '{$info['user_id']}' AND token_status='".TOKEN_INUSE."' AND token!='$token';";
             $conn_rows = array ();
             $db->execSql($sql, $conn_rows, false);
-            if (isset ($conn_rows))
-            {
-                foreach ($conn_rows as $conn_row)
-                {
+
+            if (isset ($conn_rows)) {
+                foreach ($conn_rows as $conn_row) {
                     $this->acctStop($conn_row['conn_id']);
                 }
@@ -173 +228 @@
         }
 
-        /* Delete all unused tokens for this user, so we don't fill the database with them */
-        $sql = "DELETE FROM connections "."WHERE token_status='".TOKEN_UNUSED."' AND user_id = '{$info['user_id']}';\n";
+        /*
+         * Delete all unused tokens for this user, so we don't fill the database
+         * with them
+         */
+        $sql = "DELETE FROM connections "."WHERE token_status='".TOKEN_UNUSED."' AND user_id = '{$info['user_id']}';";
         $db->execSqlUpdate($sql, false);
     }
 
-    /** Update traffic counters
-     * $conn_id: The connection id for the connection to work on */
-    function acctUpdate($conn_id, $incoming, $outgoing)
-    {
+    /**
+     * Update traffic counters
+     *
+     * @param string $conn_id  The connection id for the connection to work on
+     * @param int    $incoming Incoming traffic in bytes
+     * @param int    $outgoing Outgoing traffic in bytes
+     *
+     * @return void
+     *
+     * @access public
+     */
+    public function acctUpdate($conn_id, $incoming, $outgoing)
+    {
+        // Define globals
+        global $db;
+
         // Write traffic counters to database
-        global $db;
         $conn_id = $db->escapeString($conn_id);
         $db->execSqlUpdate("UPDATE connections SET "."incoming='$incoming',"."outgoing='$outgoing',"."last_updated=NOW() "."WHERE conn_id='{$conn_id}'");
     }
 
-    /** Final update and stop accounting
-     * $conn_id:  The connection id (the token id) for the connection to work on
+    /**
+     * Final update and stop accounting
+     *
+     * @param string $conn_id The connection id (the token id) for the
+     *                        connection to work on
+     *
+     * @return void
+     *
+     * @access public
      * */
-    function acctStop($conn_id)
-    {
+    public function acctStop($conn_id)
+    {
+        // Define globals
+        global $db;
+
         // Stop traffic counters update
-        global $db;
         $conn_id = $db->escapeString($conn_id);
         $db->execSqlUpdate("UPDATE connections SET "."timestamp_out=NOW(),"."token_status='".TOKEN_USED."' "."WHERE conn_id='{$conn_id}';\n", false);
@@ -201 +279 @@
     /**
      * Property method that tells if the class allows registration
-     */
-    function isRegistrationPermitted()
+     *
+     * @return bool Returns if the class allows registration
+     *
+     * @access public
+     */
+    public function isRegistrationPermitted()
     {
         return false;