root/trunk/wifidog-auth/wifidog/classes/Server.php @ 1392

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

// +-------------------------------------------------------------------+
// | WiFiDog Authentication Server                                     |
// | =============================                                     |
// |                                                                   |
// | The WiFiDog Authentication Server is part of the WiFiDog captive  |
// | portal suite.                                                     |
// +-------------------------------------------------------------------+
// | PHP version 5 required.                                           |
// +-------------------------------------------------------------------+
// | Homepage:     http://www.wifidog.org/                             |
// | Source Forge: http://sourceforge.net/projects/wifidog/            |
// +-------------------------------------------------------------------+
// | This program 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 2 of    |
// | the License, or (at your option) any later version.               |
// |                                                                   |
// | This program 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 this program; if not, contact:                         |
// |                                                                   |
// | Free Software Foundation           Voice:  +1-617-542-5942        |
// | 59 Temple Place - Suite 330        Fax:    +1-617-542-2652        |
// | Boston, MA  02111-1307,  USA       gnu@gnu.org                    |
// |                                                                   |
// +-------------------------------------------------------------------+

/**
 * @package    WiFiDogAuthServer
 * @author     Max Horvath <max.horvath@freenet.de>
 * @author     Benoit Grégoire <bock@step.polymtl.ca>
 * @copyright  2007 Benoit Grégoire, Technologies Coeus inc.
 * @version    Subversion $Id: $
 * @link       http://www.wifidog.org/
 */

/**
 * Load required classes
 */
require_once('classes/GenericObject.php');
require_once('classes/Security.php');
define('SERVER_ID', 'SERVER_ID');
/**
 * Administration interface for configuring Server wide settings for the server WiFiDog is running on
 *
 * @package    WiFiDogAuthServer
 * @author     Benoit Grégoire <bock@step.polymtl.ca>
 * @copyright  2007 Benoit Grégoire, Technologies Coeus inc.
 */
class Server extends GenericDataObject
{
    /** Object cache for the object factory (getObject())*/
    private static $instanceArray = array();

    /**
     * Constructor
     *
     * @param string $p_server_id Id of the server

     */
    private function __construct($p_server_id)
    {

        $db = AbstractDb::getObject();

        // Init values
        $row = null;

        $serverId = $db->escapeString($p_server_id);
        $sql = "SELECT * FROM server WHERE server_id='$serverId'";
        $db->execSqlUniqueRes($sql, $row, false);

        if ($row == null) {
            throw new Exception("The server with id $serverId could not be found in the database!");
        }

        $this->_row = $row;

        $this->_id = $db->escapeString($row['server_id']);
    }

    public function __toString() {
        return _("Main server object");
    }
    /** Get an instance of the object
     *
     * @param string $id The object id
     *
     * @return object The object, or null if there was an error (an exception
     *                is also thrown)
     *
     * @see GenericObject

     */
    public static function &getObject($id)
    {
        if(!isset(self::$instanceArray[$id]))
        {
            self::$instanceArray[$id] = new self($id);
        }
        return self::$instanceArray[$id];
    }

    /**
     * Get the server object (there is only one)
     *
     * @return object A VirtualHost object, NEVER returns null
     *
     * @static
     * @access public
     */
    public static function &getServer()
    {
        return self::getObject(SERVER_ID);
    }
    /**
     * Create a new Content object in the database
     *
     * @param string $server_id The server id of the new server. If absent,
     *                           will be assigned a guid.
     *
     * @return mixed The newly created object, or null if there was an error
     *
     * @see GenericObject
     *
     * @static
     * @access public
     */
    public static function createNewObject($server_id = null)
    {

        $db = AbstractDb::getObject();

        if (empty($server_id)) {
            $server_id = get_guid();
        }

        $server_id = $db->escapeString($server_id);

        $sql = "INSERT INTO servers (server_id) VALUES ('$server_id')";

        if (!$db->execSqlUpdate($sql, false)) {
            throw new Exception(_('Unable to insert the new server in the database!'));
        }

        $_object = self::getObject($server_id);

        return $_object;

    }

    /** Get an interface to create a new object.
     * @return html markup
     */
    public static function getCreateNewObjectUI()
    {
        throw new Exception ("Unsupported method");
    }

    /** Process the new object interface.
     *  Will       return the new object if the user has the credentials
     * necessary (Else an exception is thrown) and and the form was fully
     * filled (Else the object returns null).
     * @return the node object or null if no new node was created.
     */
    static function processCreateNewObjectUI()
    {
        throw new Exception ("Unsupported method");
    }



    /**
     * Set as the default server
     *
     * @param VirtualHost $vhost
     *
     * @return bool True on success, false on failure
     */
    public function setDefaultVirtualHost(VirtualHost $vhost)
    {

        $db = AbstractDb::getObject();
        $vhostIdStr = $db->escapeString($vhost->getId());
        // Init values
        $_retVal = false;

        if ($vhostIdStr != VirtualHost::getDefaultVirtualHost()->getId()) {
            $sql  = "UPDATE server SET default_virtual_host = '$vhostIdStr';\n";
            $_retVal = $db->execSqlUpdate($sql, false);
            $this->refresh();
        }

        return $_retVal;
    }
    /**
     * Retrieves the servers's creation date
     *
     * @return string Creation date of server
     *
     * @access public
     */
    public function getCreationDate()
    {
        return $this->_row['creation_date'];
    }

    /**
     * Retreives the admin interface of this object
     *
     * @return string The HTML fragment for this interface
     */
    public function getAdminUI()
    {
        Security::requirePermission(Permission::P('SERVER_PERM_EDIT_SERVER_CONFIG'), $this);
        // Init values
        $db = AbstractDb::getObject();
        $html = '';

        $html .= "<fieldset class='admin_container ".get_class($this)."'>\n";
        $html .= "<legend>"._("Server management")."</legend>\n";
        $html .= "<ul class='admin_element_list'>\n";
        // server_id
        /*$value = htmlspecialchars($this->getId(), ENT_QUOTES);

        $html .= "<li class='admin_element_item_container'>\n";
        $html .= "<div class='admin_element_label'>" . _("Server ID") . ":</div>\n";
        $html .= "<div class='admin_element_data'>\n";
        $html .= $value;
        $html .= "</div>\n";
        $html .= "</li>\n";*/

        // creation_date
        $name = "server_" . $this->getId() . "_creation_date";
        $value = htmlspecialchars($this->getCreationDate(), ENT_QUOTES);

        $html .= "<li class='admin_element_item_container'>\n";
        $html .= "<div class='admin_element_label'>" . _("Creation date") . ":</div>\n";
        $html .= "<div class='admin_element_data'>\n";
        $html .= $value."\n";
        $html .= "</div>\n";
        $html .= "</li>\n";

        //timezone check

        $html .= "<li class='admin_element_item_container'>\n";
        $html .= "<div class='admin_element_label'>" . _("Timezone check:  The following must be in the same timezone") . ":</div>\n";
        $html .= "<div class='admin_element_data'>\n";
        $html .= "<p>";
        $db->execSqlUniqueRes("SHOW timezone", $row, false);
        $html .= " ".sprintf(_("Timezone from postgresql: %s"), $row['TimeZone'])."</p>"; // Version < 5.0.0
        $date_default_timezone_get = 'date_default_timezone_get';
        is_callable($date_default_timezone_get)?$phpTimezone = date_default_timezone_get():$phpTimezone = "Requires PHP 5.1 to tell";
        $html .= " ".sprintf(_("Timezone from PHP: %s"), $phpTimezone)."</p>"; // Version < 5.0.0

        $html .= "</div>\n";
        $html .= "</li>\n";

        /*
         * Authentication options
         */
        $title = _("Authentication");
        $data = InterfaceElements::generateInputCheckbox("use_global_auth","", _("Use the users of default Virtual Host's network across all networks on the server."), $this->getUseGlobalUserAccounts(), "use_global_auth");

        $html .= InterfaceElements::generateAdminSectionContainer("server_authentication_options",$title, $data);
        
        /*
         * Access rights
         */
        if (true) {
            require_once('classes/Stakeholder.php');
            $html_access_rights = Stakeholder::getAssignStakeholdersUI($this);
            $html .= InterfaceElements::generateAdminSectionContainer("access_rights", _("Access rights"), $html_access_rights);
        }
        
        $html .= "</ul>\n";
        $html .= "</fieldset>\n";
        return $html;
    }

    /**
     * Process admin interface of this object
     *
     * @return void
     */
    public function processAdminUI()
    {
        require_once('classes/User.php');
        Security::requirePermission(Permission::P('SERVER_PERM_EDIT_SERVER_CONFIG'), $this);
        // Authentication
        if (isset($_REQUEST['use_global_auth']))
                $this->setUseGlobalUserAccounts($_REQUEST['use_global_auth']);
        else
                $this->setUseGlobalUserAccounts(false);
        // Access rights
        require_once('classes/Stakeholder.php');
        Stakeholder::processAssignStakeholdersUI($this, $errMsg);
        if(!empty($errMsg)) {
            echo $errMsg;
        }
    }

    /**
     * Delete this Object form the it's storage mechanism
     *
     * @param string &$errmsg Returns an explanation of the error on failure
     *
     * @return bool True on success, false on failure or access denied
     */
    public function delete(&$errmsg)
    {
        $errmsg = _('The server can never be deleted!');
        return false;
    }
    /** Menu hook function */
    static public function hookMenu() {
        $items = array();
        $server = self::getServer();
        if(Security::hasPermission(Permission::P('SERVER_PERM_EDIT_SERVER_CONFIG'), $server))
        {
            $items[] = array('path' => 'server/admin',
            'title' => _("Server configuration"),
            'url' => BASE_URL_PATH.htmlspecialchars("admin/generic_object_admin.php?object_class=Server&action=edit&object_id=".SERVER_ID."")
                );
        }
        $items[] = array('path' => 'server',
        'title' => _('Server administration'),
        'type' => MENU_ITEM_GROUPING);

        return $items;
    }
    /**
     * Reloads the object from the database
     *
     * Should normally be called after a set operation
     *
     * @return void     */
    protected function refresh()
    {
        $this->__construct($this->_id);
    }

    /**
     * Getter for UseGlobalUserAccounts
     *
     * @return bool
     */
    public function getUseGlobalUserAccounts()
    {
        if (array_key_exists('use_global_auth',$this->_row))
                return $this->_row['use_global_auth']=='t';
        else
                return False;
    } 

    /**
     * Setter for UseGlobalUserAccounts
     *
     * @param bool $value       New value
     *
     * @return bool True on success, false on failure
     */
    public function setUseGlobalUserAccounts($value)
    {
        $db = AbstractDb::getObject();
        $value = $value? true:false;
        // Init values
        $retVal = true;

        if ($value != $this->getUseGlobalUserAccounts()) {
            $value = $value ? 'true' : 'false';
            $retVal = $db->execSqlUpdate("UPDATE server SET use_global_auth = {$value} WHERE server_id = '{$this->getId()}'", false);
            $this->refresh();
        }

        return $retVal;
    } 

    /**
     * Find out how many users are online on the whole server (Actually the number of active connections.
     * This result is possibly incorrect, as it donesn't treat annonymous connections, or multiple connections differently
     * @return int Number of online users
     *
     * @access public
     */
    public function getTotalNumOnlineUsers()
    {
        $db = AbstractDb::getObject();
        // Init values
        $retval = array ();
        $row = null;
        $sql = "SELECT COUNT(token_id) as count FROM tokens JOIN connections USING (token_id) WHERE tokens.token_status='".TOKEN_INUSE."'";      
        $db->execSqlUniqueRes($sql, $row, false);
        return $row['count'];
    }

    /**
     * Find out how many users are valid in this server's database
     *
     * @return int Number of valid users
     */
    public function getTotalNumValidUsers()
    {

        $db = AbstractDb::getObject();

        // Init values
        $retval = 0;
        $row = null;
        $useCache = false;
        $cachedData = null;

        // Create new cache objects (valid for 1 minute)
        $cache = new Cache('server_num_valid_users', "default", 60);

        // Check if caching has been enabled.
        if ($cache->isCachingEnabled) {
            $cachedData = $cache->getCachedData();

            if ($cachedData) {
                // Return cached data.
                $useCache = true;
                $retval = $cachedData;
            }
        }

        if (!$useCache) {
            // Get number of valid users
            $network_id = $db->escapeString($this->_id);
            $db->execSqlUniqueRes("SELECT COUNT(user_id) FROM users WHERE account_status = ".ACCOUNT_STATUS_ALLOWED, $row, false);
            // String has been found
            $retval = $row['count'];

            // Check if caching has been enabled.
            if ($cache->isCachingEnabled) {
                // Save data into cache, because it wasn't saved into cache before.
                $cache->saveCachedData($retval);
            }
        }

        return $retval;
    }

    /**
     * Find out how many nodes are deployed in this server's database
     *
     * @return int Number of deployed nodes
     */
    public function getTotalNumDeployedNodes()
    {

        $db = AbstractDb::getObject();

        // Init values
        $retval = 0;
        $row = null;
        $useCache = false;
        $cachedData = null;

        // Create new cache objects (valid for 5 minutes)
        $cache = new Cache('server_num_deployed_nodes', "default", 300);

        // Check if caching has been enabled.
        if ($cache->isCachingEnabled) {
            $cachedData = $cache->getCachedData();

            if ($cachedData) {
                // Return cached data.
                $useCache = true;
                $retval = $cachedData;
            }
        }

        if (!$useCache) {
            // Get number of deployed nodes
            $network_id = $db->escapeString($this->_id);
            $db->execSqlUniqueRes("SELECT COUNT(node_id) FROM nodes WHERE (node_deployment_status = 'DEPLOYED' OR node_deployment_status = 'NON_WIFIDOG_NODE')", $row, false);

            // String has been found
            $retval = $row['count'];

            // Check if caching has been enabled.
            if ($cache->isCachingEnabled) {
                // Save data into cache, because it wasn't saved into cache before.
                $cache->saveCachedData($retval);
            }
        }

        return $retval;
    }

    /**
     * Find out how many deployed nodes are online in this server's database
     *
     * @param bool $nonMonitoredOnly Return number of non-monitored nodes only
     *
     * @return int Number of deployed nodes which are online
     */
    public function getNumOnlineNodes($nonMonitoredOnly = false)
    {

        $db = AbstractDb::getObject();

        // Init values
        $retval = 0;
        $row = null;
        $useCache = false;
        $cachedData = null;

        // Create new cache objects (valid for 5 minutes)
        if ($nonMonitoredOnly) {
            $cache = new Cache('server_num_online_nodes_non_monitored', "default", 300);
        } else {
            $cache = new Cache('server_num_online_nodes', "default", 300);
        }

        // Check if caching has been enabled.
        if ($cache->isCachingEnabled) {
            $cachedData = $cache->getCachedData();

            if ($cachedData) {
                // Return cached data.
                $useCache = true;
                $retval = $cachedData;
            }
        }

        if (!$useCache) {
            // Get number of online nodes
            $network_id = $db->escapeString($this->_id);

            if ($nonMonitoredOnly) {
                $db->execSqlUniqueRes("SELECT COUNT(node_id) FROM nodes WHERE node_deployment_status = 'NON_WIFIDOG_NODE' AND ((CURRENT_TIMESTAMP-last_heartbeat_timestamp) >= interval '5 minutes')", $row, false);
            } else {
                $db->execSqlUniqueRes("SELECT COUNT(node_id) FROM nodes WHERE (node_deployment_status = 'DEPLOYED' OR node_deployment_status = 'NON_WIFIDOG_NODE') AND ((CURRENT_TIMESTAMP-last_heartbeat_timestamp) < interval '5 minutes')", $row, false);
            }

            // String has been found
            $retval = $row['count'];

            // Check if caching has been enabled.
            if ($cache->isCachingEnabled) {
                // Save data into cache, because it wasn't saved into cache before.
                $cache->saveCachedData($retval);
            }
        }

        return $retval;
    }
}

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * c-hanging-comment-ender-p: nil
 * End:
 */