Changeset 788 for trunk/wifidog-auth/wifidog/classes/Node.php

Timestamp:

10/05/05 22:57:30 (8 years ago)

Author:

benoitg

Message:

it Gr�goire <bock@…>

• Remove a bunch of deprecated methods from the Node object, document undocumented methods.
• Make the node id editable. This allows the gateway "MAC address as node ID" patch by London wireless to be usable with the standard auth server, and to transition to using MAC address as node ID.
• Fix a saving problem with all the content types with some versions of PHP
• Add a new Content type: IFrameRest. This allows the result of a REST style query returning HTML to be displayed in a HTML iframeset. Currently supported are substitution of the node_id, the user_id and the last display date in the get query.
• CVS version of the auth server should now be "reasonnably" safe to use in production, so the 2005-09-01 notice is no longuer in effect.

Files:

• trunk/wifidog-auth/wifidog/classes/Node.php (modified) (21 diffs)

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

@@ -21 +21 @@
  \********************************************************************/
 /**@file Node.php
- * @author Copyright (C) 2005 Benoit Gr�goire <bock@step.polymtl.ca>
+ * @author Copyright (C) 2005 Benoit Grégoire <bock@step.polymtl.ca>
  */
 
@@ -86 +86 @@
                 $retval = null;
                 $sql = "SELECT node_id, last_heartbeat_ip from nodes WHERE last_heartbeat_ip='$_SERVER[REMOTE_ADDR]' ORDER BY last_heartbeat_timestamp DESC";
+                $node_rows = null;
                 $db->ExecSql($sql, $node_rows, false);
                 $num_match = count($node_rows);
@@ -292 +293 @@
                 $html = '';
                 $name = "{$user_prefix}";
-                $status_list = self :: getAllDeploymentStatus();
-                if ($status_list != null)
-                {
+                $status_list = null;
+                $db->ExecSql("SELECT node_deployment_status FROM node_deployment_status", $status_list, false);
+                if ($status_list == null)
+                        throw new Exception(_("No deployment statues  could be found in the database"));
+
                         $tab = array ();
                         foreach ($status_list as $status)
-                                $tab[] = array ($status, $status);
+                                $tab[] = array ($status['node_deployment_status'], $status['node_deployment_status']);
                         $html .= FormSelectGenerator :: generateFromArray($tab, $this->getDeploymentStatus(), $name, null, false);
-                }
                 return $html;
         }
@@ -322 +324 @@
                 $node_id_str = $db->EscapeString($node_id);
                 $sql = "SELECT * FROM nodes WHERE node_id='$node_id_str'";
+                $row = null;
                 $db->ExecSqlUniqueRes($sql, $row, false);
                 if ($row == null)
@@ -336 +339 @@
         }
 
+/** Changing the id of a Node is supported. 
+ *  Be carefull to anly call this when all other changes are processed, 
+ * or the id used to generate the form names may no longer match.
+ * @param $id, string, the new node id.
+ * @return true on success, false on failure. Check this, 
+ * as it's possible that someone will enter an existing id, especially
+ * if the MAC address is used and hardware is recycled.
+ */
+        function setId($id)
+        {
+                $id = $this->mDb->EscapeString($id);
+                $retval = $this->mDb->ExecSqlUpdate("UPDATE nodes SET node_id = '{$id}' WHERE node_id = '{$this->getId()}'");
+                if($retval)
+                {
+                $this->id = $id;
+                $this->refresh();
+                }
+                return $retval;
+        }
+        
         /** Gets the Network to which the node belongs 
          * @return Network object (never returns null)
@@ -657 +680 @@
                 $html .= "<div class='admin_section_title'>"._("Information about the node:")."</div>\n";
 
+
+                // Hashed node_id (this is a workaround since PHP auto-converts HTTP vars var periods, spaces or underscores )
+                $hashed_node_id = md5($this->getId());
+
                 // Node ID
                 $value = htmlspecialchars($this->getId(), ENT_QUOTES);
                 $html .= "<div class='admin_section_container'>\n";
-                $html .= "<div class='admin_section_title'>"._("ID")." : {$value}</div>\n";
-                //$html .= "<div class='admin_section_data'>\n";
-                //$name = "node_".$this->getId()."_id";
-                //$html .= "<input type='text' readonly='' size='10' value='$value' name='$name'>\n";
-                //$html .= "</div>\n";
-                $html .= "</div>\n";
-
-                // Hashed node_id (this is a workaround since PHP auto-converts HTTP vars var periods, spaces or underscores )
-                $hashed_node_id = md5($this->getId());
+                $html .= "<div class='admin_section_title'>"._("ID")." : </div>\n";
+                $html .= "<div class='admin_section_data'>\n";
+                $name = "node_".$hashed_node_id."_id";
+                $html .= "<input type='text' size='20' value='$value' name='$name'>\n";
+                $html .= "</div>\n";
+                $html .= "</div>\n";
 
                 // Name
@@ -1160 +1184 @@
 Content::processLinkedContentUI($name, 'node_has_content', 'node_id', $this->id);
 
-        }
+                // Name
+                $name = "node_".$hashed_node_id."_id";
+                $this->setId($_REQUEST[$name]);
+                                        }
 
         // Redirect to this node's portal page
@@ -1196 +1223 @@
                 global $db;
                 $retval = array ();
+                $content_rows = null;
                 // Get all network, but exclude user subscribed content if asked
                 if ($exclude_subscribed_content == true && $subscriber)
@@ -1220 +1248 @@
                 $retval = array ();
                 $sql = "SELECT * FROM content_group JOIN content ON (content.content_id = content_group.content_group_id) JOIN node_has_content ON (node_has_content.content_id = content_group.content_group_id AND node_has_content.node_id = '{$this->getId()}') WHERE is_persistent = true AND is_artistic_content = true AND is_locative_content = true ORDER BY subscribe_timestamp DESC";
+                $content_rows = null;
                 $db->ExecSql($sql, $content_rows, false);
                 if ($content_rows != null)
@@ -1242 +1271 @@
         }
 
-        /** Return all the nodes
-         */
-        static function getAllNodes()
-        {
-                global $db;
-
-                $db->ExecSql("SELECT * FROM nodes", $nodes, false);
-
-                if ($nodes == null)
-                        throw new Exception(_("No nodes could not be found in the database"));
-
-                return $nodes;
-        }
-
-        static function getAllNodesOrdered($order_by)
-        {
-                global $db;
-
-                $nodes = null;
-                $db->ExecSql("SELECT * FROM nodes ORDER BY $order_by", $nodes, false);
-
-                if ($nodes == null)
-                        throw new Exception(_("No nodes could not be found in the database"));
-
-                return $nodes;
-        }
-
-        static function getAllDeploymentStatus()
-        {
-                global $db;
-
-                $statuses = null;
-                $db->ExecSql("SELECT * FROM node_deployment_status", $statuses, false);
-                if ($statuses == null)
-                        throw new Exception(_("No deployment statues  could be found in the database"));
-
-                $statuses_array = array ();
-                foreach ($statuses as $status)
-                        array_push($statuses_array, $status['node_deployment_status']);
-
-                return $statuses_array;
-        }
-
         /** The list of users online at this node
          * @return An array of User object, or en empty array */
@@ -1291 +1277 @@
                 global $db;
                 $retval = array ();
+                $users = null;
                 $db->ExecSql("SELECT users.user_id FROM users,connections WHERE connections.token_status='".TOKEN_INUSE."' AND users.user_id=connections.user_id AND connections.node_id='{$this->id}'", $users, false);
                 if ($users != null)
@@ -1305 +1292 @@
          * @return Number of online users
          */
-        function getNumOnlineUsers($node_id = null)
+        function getNumOnlineUsers()
         {
                 global $db;
                 $retval = array ();
+                $row = null;
                 $db->ExecSqlUniqueRes("SELECT COUNT(DISTINCT users.user_id) as count FROM users,connections WHERE connections.token_status='".TOKEN_INUSE."' AND users.user_id=connections.user_id AND connections.node_id='{$this->id}'", $row, false);
                 return $row['count'];
         }
 
+        /** The list of all real owners of this node
+         * @return An array of User object, or en empty array */
         function getOwners()
         {
                 global $db;
                 $retval = array ();
+                $owners = null;
                 $db->ExecSql("SELECT user_id FROM node_stakeholders WHERE is_owner = true AND node_id='{$this->id}'", $owners, false);
                 if ($owners != null)
@@ -1328 +1319 @@
         }
 
+        /** The list of all Technical officers of this node.  
+         * Technical officers are displayed highlited and in the online user's list, 
+         * and are contacted when the Node goes down.
+         * @return An array of User object, or en empty array */
         function getTechnicalOfficers()
         {
                 global $db;
                 $retval = array ();
+                $officers = null;
                 $db->ExecSql("SELECT user_id FROM node_stakeholders WHERE is_tech_officer = true AND node_id='{$this->id}'", $officers, false);
                 if ($officers != null)
@@ -1349 +1345 @@
         {
                 global $db;
+                $rows = null;
                 $db->ExecSql("SELECT * FROM node_stakeholders WHERE node_id = '{$this->getId()}' AND user_id = '{$user->getId()}'", $rows, false);
                 if (!$rows)
@@ -1366 +1363 @@
         {
                 global $db;
+                $rows = null;
                 $db->ExecSql("SELECT * FROM node_stakeholders WHERE node_id = '{$this->getId()}' AND user_id = '{$user->getId()}'", $rows, false);
                 if (!$rows)
@@ -1374 +1372 @@
                 else
                         if (!$db->ExecSqlUpdate("UPDATE node_stakeholders SET is_tech_officer = true WHERE node_id = '{$this->getId()}' AND user_id = '{$user->getId()}';", false))
-                                throw new Exception(_('Could not add tech officer'));
-        }
-
-        /** Remove a technical officer ( tech support ) from this node
+                                throw new Exception(_('Could not set existing user as tech officer'));
+        }
+
+        /** Remove owner flag for a stakeholder of this node
          * @param User
          */
@@ -1387 +1385 @@
         }
 
-        /** Remove a technical officer ( tech support ) from this node
+        /** Remove technical officer flag for a stakeholder of this node
          * @param User
          */
@@ -1406 +1404 @@
                         $user_id = $user->getId();
                         $retval = false;
+                        $row = null;
                         $db->ExecSqlUniqueRes("SELECT * FROM node_stakeholders WHERE is_owner = true AND node_id='{$this->id}' AND user_id='{$user_id}'", $row, false);
                         if ($row != null)
@@ -1424 +1423 @@
                         $user_id = $user->getId();
                         $retval = false;
+                        $row = null;
                         $db->ExecSqlUniqueRes("SELECT * FROM node_stakeholders WHERE is_tech_officer = true AND node_id='{$this->id}' AND user_id='{$user_id}'", $row, false);
                         if ($row != null)
@@ -1440 +1440 @@
                 $id_str = $db->EscapeString($id);
                 $sql = "SELECT * FROM nodes WHERE node_id='{$id_str}'";
+                $row = null;
                 $db->ExecSqlUniqueRes($sql, $row, false);
                 if ($row != null)
@@ -1448 +1449 @@
         }
 
-        /** Warning, the semantics of this function will change *
-         * @deprecated version - 2005-04-29 USE getOnlineUsers instead
-         * */
-        public static function getAllOnlineUsers()
-        {
-                global $db;
-                $db->ExecSql("SELECT * FROM connections,users,nodes WHERE token_status='".TOKEN_INUSE."' AND users.user_id=connections.user_id AND nodes.node_id=connections.node_id ORDER BY timestamp_in DESC", $online_users);
-                return $online_users;
-        }
-
         /** Reloads the object from the database.  Should normally be called after a set operation */
         protected function refresh()