Changeset 1436

Timestamp:

12/17/09 17:02:31 (4 years ago)

Author:

gbastien

Message:

• Code refactoring: Network, NodeGroup?, Node inherit from HotspotGraphElement? (#677)

Location:

trunk/wifidog-auth

Files:

• CHANGELOG (modified) (1 diff)
• wifidog/classes/Content/ContentGroup/ContentGroupElement.php (modified) (1 diff)
• wifidog/classes/HotspotGraph.php (modified) (13 diffs)
• wifidog/classes/HotspotGraphElement.php (modified) (18 diffs)
• wifidog/classes/Network.php (modified) (17 diffs)
• wifidog/classes/Node.php (modified) (16 diffs)
• wifidog/classes/NodeGroup.php (modified) (13 diffs)
• wifidog/portal/index.php (modified) (1 diff)

trunk/wifidog-auth/CHANGELOG

@@ -1 +1 @@
 # $Id$
+
+2009-12-17
+ * Code refactoring: Network, NodeGroup, Node inherit from HotspotGraphElement (#677)
+
 2009-12-08
  * Added the concept of node group and hierarchy (in a not too clean way to start with, I will refactor the code before adding new functionalities to nodes and groups) (#246)

trunk/wifidog-auth/wifidog/classes/Content/ContentGroup/ContentGroupElement.php

@@ -332 +332 @@
         /* content_group_element_has_allowed_nodes */
         $html .= "<li class='admin_element_item_container'>\n";
-        $html .= "<div class='admin_element_label'>" . _("Only display at node(s):") . "</div>\n";
+        $html .= "<div class='admin_element_label'>" . _("Only display at node(s):") . _(" (DEPRECATED should use NodeGroups instead)") . "</div>\n";
         $html .= "<ul class='admin_element_list'>\n";
 

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

@@ -67 +67 @@
         $db = AbstractDb :: getObject();
         $allparents = array();
-        $allparents[] = $object->getId();
+        $hgeid = $object->getHgeId();
+        $allparents[] = $hgeid;
         $newchildren = array();
-        $newchildren[] = "'{$db->escapeString($object->getId())}'";      
-        
-        while (!empty($newchildren)) {
-            $parentswhere = implode(', ', $newchildren);
-            $parents_sql = "SELECT hg.parent_element_id FROM hotspot_graph hg
-                where hg.child_element_id in ({$parentswhere})"; 
-            
-            $parent_rows = null;
-            $db->execSql($parents_sql, $parent_rows, false);
-            $newchildren = array();
-            
-            if ($parent_rows) {
-                foreach ($parent_rows as $parent_row) {
-                    if (!in_array($parent_row['parent_element_id'], $allparents)) {
-                        $allparents[] = $parent_row['parent_element_id'];
-                        $newchildren[] = "'{$db->escapeString($parent_row['parent_element_id'])}'";
+        $newchildren[] = "{$db->escapeString($hgeid)}";      
+        
+        while (!empty($newchildren)) {     
+            $notvisited = array();
+            foreach ($newchildren as $child) {
+                $next_level = HotspotGraph::getParents($child);
+                if ($next_level) {
+                    foreach ($next_level as $next_row) {
+                        if (!in_array($next_row['next_element_id'], $allparents)) {
+                            $allparents[] = $next_row['next_element_id'];
+                            $notvisited[] =  $next_row['next_element_id'];
+                        }
                     }
                 }
             }
-        }
+            $newchildren = $notvisited;
+        }
+        
         return $allparents;
     }
@@ -109 +108 @@
         // Init values
         $html = "";
-        $object_id = $graph_element->getId();
+        $object_id = $db->escapeString($graph_element->getHgeId());
         
         
@@ -116 +115 @@
             
             $_title = _("Parents :");
-            $parents_sql = "SELECT hg.parent_element_id, hge.element_id, hge.element_type, coalesce(n.name, ng.name, no.name) as name FROM hotspot_graph hg
-                inner join hotspot_graph_elements hge on hg.parent_element_id = hge.hotspot_graph_element_id
-                left join networks n on hge.element_id = n.network_id AND hge.element_type='Network' 
-                left join node_groups ng on hge.element_id = ng.node_group_id AND hge.element_type = 'NodeGroup'
-                left join nodes no on hge.element_id = no.node_id AND hge.element_type = 'Node'
-                where hg.child_element_id = '{$db->escapeString($graph_element->getId())}'"; 
-            
-            $parent_rows = null;
-            $db->execSql($parents_sql, $parent_rows, false);
+            $parent_rows = HotspotGraph::getParents($object_id);
             $listData = "";
             
@@ -130 +121 @@
                 foreach ($parent_rows as $parent_row) {
                     $classname = $parent_row['element_type'];
-                    $element = HotspotGraphElement::getChildObject($classname, $parent_row['element_id']);
+                    $element = HotspotGraphElement::getObject($parent_row['element_id'], $classname);
                     $parentStr = htmlspecialchars($parent_row['name']) . " (".htmlspecialchars($parent_row['element_type']) .")  ";
-                    $name = $object_id . "_parent_" . $parent_row['parent_element_id'] . "_remove";
+                    $name = $object_id . "_parent_" . $parent_row['next_element_id'] . "_remove";
                     $listDataContents = InterfaceElements::generateAdminSection("", $parentStr, InterfaceElements::generateInputSubmit($name, _("Remove from")));
                     $listData .= "<li class='admin_element_item_container node_owner_list'>".$listDataContents."</li>\n";
@@ -139 +130 @@
             
             $listData .= "<li class='admin_element_item_container'>";
-            $listData .= HotspotGraphElement::getSelectGraphElementUI($object_id . "_parent_add_element", array('additionalWhere' => " AND element_type in ('Network', 'NodeGroup') AND hotspot_graph_element_id != '{$db->escapeString($graph_element->getId())}'"));
+            $listData .= HotspotGraphElement::getSelectGraphElementUI($object_id . "_parent_add_element", array('additionalWhere' => " AND element_type in ('Network', 'NodeGroup') AND hotspot_graph_element_id != '{$db->escapeString($graph_element->getHgeId())}'"));
             $listData .= InterfaceElements::generateInputSubmit($object_id . "_parent_add", _("Add"));
             $listData .= "<br class='clearbr' /></li>\n";
@@ -154 +145 @@
             
             $_title = _("Children :");
-            $children_sql = "SELECT hg.child_element_id, hge.element_id, hge.element_type, coalesce(n.name, ng.name, no.name) as name FROM hotspot_graph hg
-                inner join hotspot_graph_elements hge on hg.child_element_id = hge.hotspot_graph_element_id
-                left join networks n on hge.element_id = n.network_id AND hge.element_type='Network' 
-                left join node_groups ng on hge.element_id = ng.node_group_id AND hge.element_type = 'NodeGroup'
-                left join nodes no on hge.element_id = no.node_id AND hge.element_type = 'Node'
-                where hg.parent_element_id = '{$db->escapeString($graph_element->getId())}'"; 
-            
-            $children_rows = null;
-            $db->execSql($children_sql, $children_rows, false);
+            $children_rows = HotspotGraph::getChildren($object_id);
             $listData = "";
             
@@ -168 +151 @@
                 foreach ($children_rows as $child_row) {
                     $classname = $child_row['element_type'];
-                    $element = HotspotGraphElement::getChildObject($classname, $child_row['element_id']);
+                    $element = HotspotGraphElement::getObject($child_row['element_id'], $classname);
                     $childStr = htmlspecialchars($child_row['name']) . " (".htmlspecialchars($child_row['element_type']) .")  ";;
-                    $name = $object_id . "_child_" . $child_row['child_element_id'] . "_remove";
+                    $name = $object_id . "_child_" . $child_row['next_element_id'] . "_remove";
                     $listDataContents = InterfaceElements::generateAdminSection("", $childStr, InterfaceElements::generateInputSubmit($name, _("Remove from")));
                     $listData .= "<li class='admin_element_item_container node_owner_list'>".$listDataContents."</li>\n";
@@ -177 +160 @@
             
             $listData .= "<li class='admin_element_item_container'>";
-            $listData .= HotspotGraphElement::getSelectGraphElementUI($object_id . "_child_add_element", array('additionalWhere' => " AND element_type in ('Node', 'NodeGroup') AND hotspot_graph_element_id != '{$db->escapeString($graph_element->getId())}'"));
+            $listData .= HotspotGraphElement::getSelectGraphElementUI($object_id . "_child_add_element", array('additionalWhere' => " AND element_type in ('Node', 'NodeGroup') AND hotspot_graph_element_id != '{$db->escapeString($graph_element->getHgeId())}'"));
             $listData .= InterfaceElements::generateInputSubmit($object_id . "_child_add", _("Add"));
             $listData .= "<br class='clearbr' /></li>\n";
@@ -201 +184 @@
     {
         $db = AbstractDb::getObject();
-        $object_id = $db->escapeString($graph_element->getId());
+        $object_id = $db->escapeString($graph_element->getHgeId());
         $allparents = array();
         
         // Process the parents
         // Process any remove element command
-        $parents_sql = "SELECT hg.parent_element_id, hge.element_id, hge.element_type, coalesce(n.name, ng.name, no.name) as name FROM hotspot_graph hg
-                inner join hotspot_graph_elements hge on hg.parent_element_id = hge.hotspot_graph_element_id
-                left join networks n on hge.element_id = n.network_id AND hge.element_type='Network' 
-                left join node_groups ng on hge.element_id = ng.node_group_id AND hge.element_type = 'NodeGroup'
-                left join nodes no on hge.element_id = no.node_id AND hge.element_type = 'Node'
-                where hg.child_element_id = '{$object_id}'"; 
-            
-        $parent_rows = null;
-        $db->execSql($parents_sql, $parent_rows, false);
+        $parent_rows = HotspotGraph::getParents($object_id);
         $allparents = array();
         
         if($parent_rows) {
             foreach ($parent_rows as $parent_row) {
-                $allparents[$parent_row['parent_element_id']] = $parent_row['name'];
-                $name = $object_id . "_parent_" . $parent_row['parent_element_id'] . "_remove";
+                $allparents[$parent_row['next_element_id']] = $parent_row['name'];
+                $name = $object_id . "_parent_" . $parent_row['next_element_id'] . "_remove";
                 if(!empty($_REQUEST[$name])) {
-                    $parentIdStr = $db->escapeString($parent_row['parent_element_id']);
+                    $parentIdStr = $db->escapeString($parent_row['next_element_id']);
                     $sql = "DELETE FROM hotspot_graph WHERE parent_element_id='$parentIdStr' AND child_element_id='$object_id';";
                     $db->execSqlUpdate($sql, false);
@@ -235 +210 @@
             if ($element) {
                 //The user and role exist
-                if(isset($allparents[$element->getId()])) {
-                    $errMsg .= sprintf(_("Element %s is already a parent of this object"), $allparents[$element->getId()]);
+                if(isset($allparents[$element->getHgeId()])) {
+                    $errMsg .= sprintf(_("Element %s is already a parent of this object"), $allparents[$element->getHgeId()]);
+                } elseif (HotspotGraph::detectCycle($graph_element, $element->getHgeId(), false)) {
+                    $errMsg .= sprintf(_("Cycle detected while adding element '%s' as a parent of this object: this element is already among the children of this object."), $element->__toString());
                 }
                 else {// the user doesn't already have that role
-                    $sql = "INSERT INTO hotspot_graph (parent_element_id, child_element_id) VALUES ('{$element->getId()}', '{$object_id}');";
+                    $sql = "INSERT INTO hotspot_graph (parent_element_id, child_element_id) VALUES ('{$element->getHgeId()}', '{$object_id}');";
                     $db->execSqlUpdate($sql, false);
     
@@ -248 +225 @@
         // Process the children
         // Process any remove element command
-        $children_sql = "SELECT hg.child_element_id, hge.element_id, hge.element_type, coalesce(n.name, ng.name, no.name) as name FROM hotspot_graph hg
-                inner join hotspot_graph_elements hge on hg.child_element_id = hge.hotspot_graph_element_id
-                left join networks n on hge.element_id = n.network_id AND hge.element_type='Network' 
-                left join node_groups ng on hge.element_id = ng.node_group_id AND hge.element_type = 'NodeGroup'
-                left join nodes no on hge.element_id = no.node_id AND hge.element_type = 'Node'
-                where hg.parent_element_id = '{$object_id}'"; 
-            
-        $children_rows = null;
-        $db->execSql($children_sql, $children_rows, false);
+        $children_rows = HotspotGraph::getChildren($object_id);
+        
         $allchildren = array();
         
         if($children_rows) {
             foreach ($children_rows as $child_row) {
-                $allchildren[$child_row['child_element_id']] = $child_row['name'];
-                $name = $object_id . "_child_" . $child_row['child_element_id'] . "_remove";
+                $allchildren[$child_row['next_element_id']] = $child_row['name'];
+                $name = $object_id . "_child_" . $child_row['next_element_id'] . "_remove";
                 if(!empty($_REQUEST[$name])) {
-                    $childIdStr = $db->escapeString($child_row['child_element_id']);
+                    $childIdStr = $db->escapeString($child_row['next_element_id']);
                     $sql = "DELETE FROM hotspot_graph WHERE parent_element_id='$object_id' AND child_element_id='$childIdStr';";
                     $db->execSqlUpdate($sql, false);
@@ -277 +247 @@
             if ($element) {
                 //The user and role exist
-                if(isset($allchildren[$element->getId()])) {
-                    $errMsg .= sprintf(_("Element '%s' is already a child of this object"), $allchildren[$element->getId()]);
-                }
-                elseif (isset($allparents[$element->getId()])) {
-                    $errMsg .= sprintf(_("Element '%s' is a parent of this object and therefore cannot be a child as well"), $allparents[$element->getId()]);
+                if(isset($allchildren[$element->getHgeId()])) {
+                    $errMsg .= sprintf(_("Element '%s' is already a child of this object"), $allchildren[$element->getHgeId()]);
+                }
+                elseif (HotspotGraph::detectCycle($graph_element, $element->getHgeId(), true)) {
+                    $errMsg .= sprintf(_("Cycle detected while adding element '%s' as a child of this object: this element is already among the parents of this object."), $element->__toString());
                 }
                 else {// the user doesn't already have that role
-                    $sql = "INSERT INTO hotspot_graph (child_element_id, parent_element_id) VALUES ('{$element->getId()}', '{$object_id}');";
+                    $sql = "INSERT INTO hotspot_graph (child_element_id, parent_element_id) VALUES ('{$element->getHgeId()}', '{$object_id}');";
                     $db->execSqlUpdate($sql, false);
     
@@ -291 +261 @@
         }
         return null;
+    }
+    
+    /**
+     * Returns an array of rows containing information on the children of this node
+     * @param string $element the db-escaped hotspot_graph_element_id
+     * @return array
+     */
+    public static function getChildren($object_id) {
+        $db = AbstractDb::getObject();
+        
+        $children_sql = "SELECT hg.child_element_id as next_element_id, hge.element_id, hge.element_type, coalesce(n.name, ng.name, no.name) as name FROM hotspot_graph hg
+                inner join hotspot_graph_elements hge on hg.child_element_id = hge.hotspot_graph_element_id
+                left join networks n on hge.element_id = n.network_id AND hge.element_type='Network' 
+                left join node_groups ng on hge.element_id = ng.node_group_id AND hge.element_type = 'NodeGroup'
+                left join nodes no on hge.element_id = no.node_id AND hge.element_type = 'Node'
+                where hg.parent_element_id = '{$object_id}'"; 
+            
+        $children_rows = null;
+        $db->execSql($children_sql, $children_rows, false);
+        return $children_rows;
+    }    
+    
+    /**
+     * Returns an array of rows containing information on the parents of this node
+     * @param string $element the db-escaped hotspot_graph_element_id
+     * @return array
+     */
+    public static function getParents($object_id) {
+        $db = AbstractDb::getObject();
+        
+        $parents_sql = "SELECT hg.parent_element_id as next_element_id, hge.element_id, hge.element_type, coalesce(n.name, ng.name, no.name) as name FROM hotspot_graph hg
+                inner join hotspot_graph_elements hge on hg.parent_element_id = hge.hotspot_graph_element_id
+                left join networks n on hge.element_id = n.network_id AND hge.element_type='Network' 
+                left join node_groups ng on hge.element_id = ng.node_group_id AND hge.element_type = 'NodeGroup'
+                left join nodes no on hge.element_id = no.node_id AND hge.element_type = 'Node'
+                where hg.child_element_id = '{$object_id}'"; 
+            
+        $parent_rows = null;
+        $db->execSql($parents_sql, $parent_rows, false);
+        return $parent_rows;
+        
+    }
+    
+    /**
+     * Detect if the addition of element with id $object_id as either parent or child would cause the graph to have a cycle
+     * @param HotspotGraphElement $start_element The element to start cycle detection with
+     * @param string $object_id The object_id of the element to add to the graph from $start_elelemtn
+     * @param boolean $child if the element to add to the graph is a child of the start_element or a parent
+     * @return boolean (true if cycle detected)
+     */
+    protected static function detectCycle($start_element, $object_id, $child = true) {
+        // If the element is a child, we check for its presence in the parents and vice versa
+        if ($child) {
+            $function = 'getParents';
+        } else {
+            $function = 'getChildren';
+        }
+        $db = AbstractDb::getObject();
+        $start_object_id = $db->escapeString($start_element->getHgeId());
+        return HotspotGraph::isCycle($start_object_id, $function, $object_id);
+    }
+    
+    /**
+     * 
+     * @param string $start_object_id The id of the object to start the search from
+     * @param string $function the function to get the next level of elements
+     * @param string $object_id the object id to searhc for
+     * @param array $visited the array of visited element
+     * @return boolean true if cycle
+     */
+    protected static function isCycle($start_object_id, $function, $object_id, &$visited = array()) {
+       
+        if ($start_object_id == $object_id)
+            return true;
+        $visited[] = $start_object_id;
+        $cycle = false;
+        $next_level = HotspotGraph::$function($start_object_id);
+        if ($next_level) {
+            foreach ($next_level as $next_row) {
+                if (!in_array($next_row['next_element_id'], $visited))
+                    $cycle = $cycle || HotspotGraph::isCycle($next_row['next_element_id'], $function, $object_id, $visited);
+                if ($cycle)
+                    break;
+            }
+        }
+        return $cycle;
     }
 

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

@@ -47 +47 @@
 require_once('classes/Content.php');
 require_once('classes/User.php');
-require_once('classes/Node.php');
-require_once('classes/Network.php');
-require_once('classes/NodeGroup.php');
 require_once('classes/HotspotGraph.php');
 
@@ -60 +57 @@
  * @package    WiFiDogAuthServer
  * @author     Geneviève Bastien <gbastien@versatic.net>
- * @todo                 Logically, Network, Node and NodeGroup should inherit from HotspotGraphElement, the base class, but one change
- *             at a time.  First we'll add the possibility to group nodes easily and add contents to those groups.
- *             For this purpose at this point, Hotspot graph element will be rather considered as a part of the child instead of its parent.
- *             If reactions are good to those additions, the logic of the interface will be changed to make the graph more central and have
- *             Networks, nodes and nodeGroups just elements types.
  */
-class HotspotGraphElement extends GenericDataObject
+abstract class HotspotGraphElement extends GenericDataObject
 {
     /** Object cache for the object factory (getObject())*/
     protected static $instanceArray = array('Network' => array(), 'Node' => array(), 'NodeGroup' => array());
-    protected static $possibleTypes = array('Network', 'Node', 'NodeGroup');
+    protected $_hgeid;
+    protected $_hgerow;
 
     /**
@@ -88 +81 @@
     public static function &getObject($id, $type = 'Node')
     {
+        if (!(class_exists($type) && (get_parent_class($type) == 'HotspotGraphElement')))
+            throw new Exception(_("HotspotGraphElement::getObject, parameter type has a wrong value.  Should be the name of a child class."));
         if(!isset(self::$instanceArray[$type][$id]))
         {
-            self::$instanceArray[$type][$id] = new self($type, $id);
+            self::$instanceArray[$type][$id] = new $type($id);
         }
         return self::$instanceArray[$type][$id];
-    }
-    
-                /**
-     * Get an instance of the child object of this graph element (the element represented by this)
-     *
-     * 
-     * @param string $id The object id
-     * @param string $type The type of graph element: Node, Network or NodeGroup
-     *
-     * @return mixed An object of type Network, Node or NodeGroup
-     *
-     * @see GenericObject
-     * @static
-     * @access public
-     */
-    public static function &getChildObject($id, $type = 'Node')
-    {
-        $object = null;
-        switch($type) {
-            case 'Network': $object = Network::getObject($id);
-                break;
-            case 'NodeGroup': $object = NodeGroup::getObject($id);
-                break;
-            case 'Node': $object = Node::getObject($id);
-                break;
-
-        }
-        return $object;
-    }
-    
-                /**
-     * Get an instance of this class for a child object
-     *
-     * 
-     * @param object $object The object id
-     * @param string $type The type of graph element: Node, Network or NodeGroup
-     *
-     * @return mixed An object of type Network, Node or NodeGroup
-     *
-     * @see GenericObject
-     * @static
-     * @access public
-     */
-    public static function &getObjectFor($object)
-    {
-        $object_id = $object->getId();
-        if ($object instanceof Network) {
-            return self::getObject($object_id, 'Network');
-        }
-        elseif ($object instanceof NodeGroup) {
-            return self::getObject($object_id, 'NodeGroup');
-        }
-        elseif ($object instanceof Node) {
-            return self::getObject($object_id, 'Node');
-        }
-        else {
-            throw new Exception(_('HotspotGraphElement: getObjectFor an object of a wrong class'));
-        }
-        return null;
     }
 
@@ -158 +94 @@
      * Thanks and so long for all the ram.
      */
-    public static function freeObject($id)
-    {
-        if(isset(self::$instanceArray[$id]))
+    public static function freeObject($id, $type)
+    {
+        if (!(class_exists($type) && (get_parent_class($type) == 'HotspotGraphElement')))
+            throw new Exception(_("HotspotGraphElement::freeObject, parameter type has a wrong value.  Should be the name of a child class."));
+        if(isset(self::$instanceArray[$type][$id]))
         {
-            unset(self::$instanceArray[$id]);
+            unset(self::$instanceArray[$type][$id]);
         }
     }
@@ -183 +121 @@
         $graph_element_id = get_guid();
         
-        if (!in_array($element_type, self::$possibleTypes))
+         if (!(class_exists($element_type) && (get_parent_class($element_type) == 'HotspotGraphElement')))
             throw new Exception(_('Cannot add element to hotspot graph. Wrong type specified: ').$element_type);
        
@@ -189 +127 @@
 
         if (!$db->execSqlUpdate($sql, false)) {
-            throw new Exception(_('Unable to insert the new network in the database!'));
+            throw new Exception(_('Unable to insert the new element in the database!'));
         }
         $object = self::getObject($element_id, $element_type);
@@ -364 +302 @@
      * @access private
      */
-    private function __construct($type, $id)
+    protected function __construct($id, $type)
     {
         $db = AbstractDb::getObject();
@@ -375 +313 @@
             throw new Exception("The element of type $type with id $element_id_str could not be found in the database");
         }
-        $this->_row = $row;
-        $this->_id = $row['hotspot_graph_element_id'];
-    }
-
-    public function __toString()
-    {
-        return $this->getId();
-    }
+        $this->_hgerow = $row;
+        $this->_hgeid = $row['hotspot_graph_element_id'];
+    }
+
+    public function getHgeId() {
+        return $this->_hgeid;
+    }
+    
+    public abstract function __toString();
 
     /**
@@ -389 +328 @@
      * @return string
      */
-    protected function getType() {
-        return $this->_row['element_type'];
-    }
+    protected abstract function getType();
   
     /**
@@ -397 +334 @@
      * @return boolean
      */
-    public function isRoot() {
-        return ($this->getType() == 'Network');
-    }
+    public abstract function isRoot() ;
     
                 /**
@@ -405 +340 @@
      * @return boolean
      */
-    public function isLeaf() {
-        return ($this->getType() == 'Node');
-    }
+    public abstract function isLeaf();
 
     /**
@@ -421 +354 @@
         require_once('classes/Stakeholder.php');
         
-        $hge_id = $this->getId();
-        
+        $hge_id = $this->getHgeId();
+
         $_html_content = array();
         $_title = _("Node content");
-        $_data = Content::getLinkedContentUI("hge_" . $hge_id . "_content", "hotspot_graph_element_has_content", "hotspot_graph_element_id", $this->_id, "portal");
+        $_data = Content::getLinkedContentUI("hge_" . $hge_id . "_content", "hotspot_graph_element_has_content", "hotspot_graph_element_id", $hge_id, "portal");
         $html .= InterfaceElements::generateAdminSectionContainer("node_content", $_title, $_data);
         
@@ -441 +374 @@
     public function processContentAdminUI()
     {
-        $hge_id = $this->getId();
+        $hge_id = $this->getHgeId();
         
         $name = "hge_{$hge_id}_content";
-        Content::processLinkedContentUI($name, 'hotspot_graph_element_has_content', 'hotspot_graph_element_id', $this->_id);
+        Content::processLinkedContentUI($name, 'hotspot_graph_element_has_content', 'hotspot_graph_element_id', $hge_id);
         
     }
@@ -464 +397 @@
         // Group section
         if (is_null($network) || Security::hasPermission(Permission::P('NETWORK_PERM_ALLOW_GROUP_NODE'), $network)) {
-            $hge_id = $this->getId();
+            $hge_id = $this->getHgeId();
         
             $_html_content = array();
@@ -484 +417 @@
     public function processGraphAdminUI(&$errMsg, $network = null)
     {
-        $hge_id = $this->getId();
+        $hge_id = $this->getHgeId();
         
         if (is_null($network) || Security::hasPermission(Permission::P('NETWORK_PERM_ALLOW_GROUP_NODE'), $network)) {
@@ -580 +513 @@
         $db = AbstractDb::getObject();
 
-        $content_id = $db->escapeString($content->getId());
-        $sql = "INSERT INTO hotspot_graph_element_has_content (hotspot_graph_element_id, content_id) VALUES ('$this->_id','$content_id')";
+        $content_id = $db->escapeString($content->getHgeId());
+        $sql = "INSERT INTO hotspot_graph_element_has_content (hotspot_graph_element_id, content_id) VALUES ('$this->_hgeid','$content_id')";
         $db->execSqlUpdate($sql, false);
     }
@@ -598 +531 @@
         $db = AbstractDb::getObject();
 
-        $content_id = $db->escapeString($content->getId());
-        $sql = "DELETE FROM hotspot_graph_element_has_content WHERE hotspot_graph_element_id='$this->_id' AND content_id='$content_id'";
+        $content_id = $db->escapeString($content->getHgeId());
+        $sql = "DELETE FROM hotspot_graph_element_has_content WHERE hotspot_graph_element_id='$this->_hgeid' AND content_id='$content_id'";
         $db->execSqlUpdate($sql, false);
     }
-
-    /**
-     * 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
-     *
-     * @access public
-     */
-    public function delete(& $errmsg)
+    
+    
+    /** Delete this Object form it's storage mechanism
+     * @param &$errmsg Appends an explanation of the error on failure
+     * @return true on success, false on failure or access denied */
+    public function delete(& $errmsg) {
+        $errmsg .= sprintf(_("Delete not supported on class %s"),get_class($this));
+        return false;
+    }
+
+    /**
+     * Function called by the children of this class to delete the parent element form the graph
+     * @param unknown_type $errmsg
+     * @return unknown_type
+     */
+    protected function _delete(& $errmsg)
     {
         // Init values
         $retval = false;
-        if ($this->isDefaultNetwork() === true) {
-            $errmsg = _('Cannot delete default network, create another one and select it before you remove this one.');
+        
+        $db = AbstractDb::getObject();
+        $id = $db->escapeString($this->getHgeId());
+        if (!$db->execSqlUpdate("DELETE FROM hotspot_graph_elements WHERE hotspot_graph_element_id='{$id}'", false)) {
+            $errmsg = _('Could not delete graph element!');
         } else {
-            $db = AbstractDb::getObject();
-            $id = $db->escapeString($this->getId());
-            if (!$db->execSqlUpdate("DELETE FROM hotspot_graph_elements WHERE hotspot_graph_element_id='{$id}'", false)) {
-                $errmsg = _('Could not delete graph element!');
-            } else {
-                $retval = true;
-            }
-        }
-
+            $retval = true;
+        }
 
         return $retval;
@@ -644 +578 @@
         //$this->__construct($this->_id);
     }
+    
+
 
     /** Menu hook function */

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

@@ -47 +47 @@
  * Load required classes
  */
-require_once('classes/GenericDataObject.php');
 require_once('classes/Content.php');
 require_once('classes/User.php');
 require_once('classes/Node.php');
+require_once('classes/NodeGroup.php');
 require_once('classes/GisPoint.php');
 require_once('classes/Cache.php');
@@ -68 +68 @@
  * @copyright  2006 Max Horváth, Horvath Web Consulting
  */
-class Network extends GenericDataObject
+class Network extends HotspotGraphElement
 {
     /** Object cache for the object factory (getObject())*/
-    private static $instanceArray = array();
-    protected $_hotspotGraphElement;
 
     /**
@@ -88 +86 @@
     public static function &getObject($id)
     {
-        if(!isset(self::$instanceArray[$id]))
-        {
-            self::$instanceArray[$id] = new self($id);
-        }
-        return self::$instanceArray[$id];
+        return HotspotGraphElement::getObject($id, 'Network');
     }
 
@@ -101 +95 @@
     public static function freeObject($id)
     {
-        if(isset(self::$instanceArray[$id]))
-        {
-            unset(self::$instanceArray[$id]);
-        }
+        HotspotGraphElement::freeObject($id, 'Network');
     }
 
@@ -192 +183 @@
     public static function createNewObject($network_id = null)
     {
+        
         $db = AbstractDb::getObject();
         if (empty ($network_id)) {
@@ -380 +372 @@
      * @access private
      */
-    private function __construct($p_network_id)
+    protected function __construct($p_network_id)
     {
         $db = AbstractDb::getObject();
@@ -395 +387 @@
         $this->_row = $row;
         $this->_id = $p_network_id;
-        $this->_hotspotGraphElement = HotspotGraphElement::getObject($this->_id,'Network');
+        parent::__construct($this->_id, 'Network');
     }
 
@@ -1706 +1698 @@
         $data = Content::getLinkedContentUI($name, "network_has_content", "network_id", $this->_id, $display_page = "portal");
         $html .= InterfaceElements::generateAdminSectionContainer("network_content", $title, $data);*/
-        if (!is_null($this->_hotspotGraphElement))
-            $html .= $this->_hotspotGraphElement->getContentAdminUI();
+        
+        $html .= parent::getContentAdminUI();
 
         /*
@@ -1937 +1929 @@
         
         // objects hierarchy
-        if (!is_null($this->_hotspotGraphElement))
-            $html .= $this->_hotspotGraphElement->getGraphAdminUI($this);
+        $html .= parent::getGraphAdminUI($this);
 
         $html .= "</ul>\n";
@@ -1958 +1949 @@
 
         // Content management
-        if (!is_null($this->_hotspotGraphElement))
-            $this->_hotspotGraphElement->processContentAdminUI();
+        parent::processContentAdminUI();
         /* $name = "network_".$this->_id."_content";
         Content :: processLinkedContentUI($name, 'network_has_content', 'network_id', $this->_id);*/
@@ -2079 +2069 @@
         ProfileTemplate :: processLinkedProfileTemplateUI($name, 'network_has_profile_templates', 'network_id', $this->_id);
         
-        if (!is_null($this->_hotspotGraphElement))
-            $this->_hotspotGraphElement->processGraphAdminUI($errMsg, $this);
+        parent::processGraphAdminUI($errMsg, $this);
         if(!empty($errMsg)) {
             echo $errMsg;
@@ -2103 +2092 @@
      * @access public
      */
-    public function addContent(Content $content)
+ /*   public function addContent(Content $content)
     {
         $db = AbstractDb::getObject();
@@ -2110 +2099 @@
         $sql = "INSERT INTO network_has_content (network_id, content_id) VALUES ('$this->_id','$content_id')";
         $db->execSqlUpdate($sql, false);
-    }
+    }*/
 
     /**
@@ -2121 +2110 @@
      * @access public
      */
-    public function removeContent(Content $content)
+ /*   public function removeContent(Content $content)
     {
         $db = AbstractDb::getObject();
@@ -2128 +2117 @@
         $sql = "DELETE FROM network_has_content WHERE network_id='$this->_id' AND content_id='$content_id'";
         $db->execSqlUpdate($sql, false);
-    }
+    }*/
 
 
@@ -2205 +2194 @@
                 $errmsg = _('Could not delete network!');
             } else {
+                parent::_delete($errmsg);
                 $retval = true;
             }
@@ -2274 +2264 @@
         $smarty->assign('networkNumNonMonitoredNodes', $net ? $net->getNumOnlineNodes(true) : 0);
     }
+    
+/**
+     * Get the type of graph element (read-only for now)
+     * 
+     * @return string
+     */
+    protected function getType() {
+        return 'Network';
+    }
+  
+    /**
+     * Return whether this element is a root or has parent (Network is root)
+     * @return boolean
+     */
+    public function isRoot(){
+        return true;
+    }
+    
+                /**
+     * Return whether this element is a leaf or has children (Node is leaf)
+     * @return boolean
+     */
+    public function isLeaf() {
+        return false;
+    }
 }
 

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

@@ -62 +62 @@
  * @copyright  2005 Benoit Grégoire, Technologies Coeus inc.
  */
-class Node implements GenericObject
+class Node extends HotspotGraphElement
 {
     /** Object cache for the object factory (getObject())*/
-    private static $instanceArray = array();
-    private $_row;
-    private $mdB; /**< An AbstractDb instance */
-    private $id;
-    private static $currentNode = null;
-    protected $_hotspotGraphElement;
+    protected $_row;
+    protected $mdB; /**< An AbstractDb instance */
+    protected $id;
+    protected static $currentNode = null;
 
     /**
@@ -78 +76 @@
      * @access private
      */
-    private $_deploymentStatuses = array();
+    protected $_deploymentStatuses = array();
 
     /**
@@ -87 +85 @@
      * @access private
      */
-    private $_warningMessage;
+    protected $_warningMessage;
 
     /** Instantiate a node object
@@ -95 +93 @@
     public static function &getObject($id)
     {
-        if(!isset(self::$instanceArray[$id]))
-        {
-            self::$instanceArray[$id] = new self($id);
-        }
-        return self::$instanceArray[$id];
+        return HotspotGraphElement::getObject($id, 'Node');
     }
 
@@ -108 +102 @@
     public static function freeObject($id)
     {
-        if(isset(self::$instanceArray[$id]))
-        {
-            unset(self::$instanceArray[$id]);
-        }
+        HotspotGraphElement::freeObject($id, 'Node');
     }
 
@@ -226 +217 @@
             else
             {
+                parent::_delete($errmsg);
                 $retval = true;
             }
@@ -663 +655 @@
     /** @param $id The id of the node
      * @param $idType 'NODE_ID' or 'GATEWAY_ID'*/
-    private function __construct($id, $idType='NODE_ID')
+    protected function __construct($id, $idType='NODE_ID')
     {
         $db = AbstractDb::getObject();
@@ -698 +690 @@
         $this->id = $row['node_id'];
         
-        $this->_hotspotGraphElement = HotspotGraphElement::getObject($this->id, 'Node');
+        parent::__construct($this->id, 'Node');
     }
 
@@ -1197 +1189 @@
         $_data = Content::getLinkedContentUI("node_" . $node_id . "_content", "node_has_content", "node_id", $this->id, "portal");
         $html .= InterfaceElements::generateAdminSectionContainer("node_content", $_title, $_data);*/
-        if (!is_null($this->_hotspotGraphElement))
-            $html .= $this->_hotspotGraphElement->getContentAdminUI();
+        $html .= parent::getContentAdminUI();
             
         // Name
@@ -1372 +1363 @@
         
         //Node hierarchy
-        if (!is_null($this->_hotspotGraphElement))
-            $html .= $this->_hotspotGraphElement->getGraphAdminUI($network);
+        $html .= parent::getGraphAdminUI($network);
 
         $html .= "</ul>\n";
@@ -1416 +1406 @@
         }
         // Content processing
-        if (!is_null($this->_hotspotGraphElement))
-            $this->_hotspotGraphElement->processContentAdminUI();
+        parent::processContentAdminUI();
         /*$name = "node_{$node_id}_content";
         Content::processLinkedContentUI($name, 'node_has_content', 'node_id', $this->id);*/
@@ -1581 +1570 @@
         // End Node configuration section
         
-        if (!is_null($this->_hotspotGraphElement))
-            $this->_hotspotGraphElement->processGraphAdminUI($errMsg, $network);
+        parent::processGraphAdminUI($errMsg, $network);
         if(!empty($errMsg)) {
             echo $errMsg;
@@ -1602 +1590 @@
 
     /** Add content to this node */
-    public function addContent(Content $content)
+   /* public function addContent(Content $content)
     {
         $db = AbstractDb::getObject();
@@ -1609 +1597 @@
         $db->execSqlUpdate($sql, false);
         exit;
-    }
+    }*/
 
     /** Remove content from this node */
-    public function removeContent(Content $content)
+   /* public function removeContent(Content $content)
     {
         $db = AbstractDb::getObject();
@@ -1618 +1606 @@
         $sql = "DELETE FROM node_has_content WHERE node_id='$this->id' AND content_id='$content_id'";
         $db->execSqlUpdate($sql, false);
-    }
+    }*/
 
     /**
@@ -1832 +1820 @@
         $smarty->assign('realNodeLastHeartbeatIP', $node ? $node->getLastHeartbeatIP() : '');
     }
+    
+    /**
+     * Get the type of graph element (read-only for now)
+     * 
+     * @return string
+     */
+    protected function getType() {
+        return 'Node';
+    }
+  
+    /**
+     * Return whether this element is a root or has parent (Network is root)
+     * @return boolean
+     */
+    public function isRoot(){
+        return false;
+    }
+    
+                /**
+     * Return whether this element is a leaf or has children (Node is leaf)
+     * @return boolean
+     */
+    public function isLeaf() {
+        return true;
+    }
+    
 }
 

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

@@ -58 +58 @@
  * @copyright  2005 Benoit Grégoire, Technologies Coeus inc.
  */
-class NodeGroup implements GenericObject
+class NodeGroup extends HotspotGraphElement
 {
     /** Object cache for the object factory (getObject())*/
-    private static $instanceArray = array();
-    private $_row;
-    private $mdB; /**< An AbstractDb instance */
-    private $id;
-    protected $_hotspotGraphElement;
+    protected $_row;
+    protected $mdB; /**< An AbstractDb instance */
+    protected $id;
     
     /**
@@ -74 +72 @@
      * @access private
      */
-    private $_warningMessage;
+    protected $_warningMessage;
 
     /** Instantiate a nodeGroup object
@@ -82 +80 @@
     public static function &getObject($id)
     {
-        if(!isset(self::$instanceArray[$id]))
-        {
-            self::$instanceArray[$id] = new self($id);
-        }
-        return self::$instanceArray[$id];
+        return HotspotGraphElement::getObject($id, 'NodeGroup');
     }
 
@@ -95 +89 @@
     public static function freeObject($id)
     {
-        if(isset(self::$instanceArray[$id]))
-        {
-            unset(self::$instanceArray[$id]);
-        }
+        HotspotGraphElement::freeObject($id, 'NodeGroup');
     }
     
@@ -316 +307 @@
     /** @param $id The id of the node group
      * @param $idType 'GROUP_ID' or 'NAME'*/
-    private function __construct($id, $idType='GROUP_ID')
+    protected function __construct($id, $idType='GROUP_ID')
     {
         $db = AbstractDb::getObject();
@@ -342 +333 @@
         $this->id = $row['node_group_id'];
         
-        $this->_hotspotGraphElement = HotspotGraphElement::getObject($this->id, 'NodeGroup');
+        parent::__construct($this->id, 'NodeGroup');
     }
 
@@ -464 +455 @@
 
         //Node content
-        if (!is_null($this->_hotspotGraphElement))
-            $html .= $this->_hotspotGraphElement->getContentAdminUI();
+        $html .= parent::getContentAdminUI();
             
         //Node hierarchy
-        if (!is_null($this->_hotspotGraphElement))
-            $html .= $this->_hotspotGraphElement->getGraphAdminUI();
+        $html .= parent::getGraphAdminUI();
             
         // Build section
@@ -515 +504 @@
 
         // Content processing
-        if (!is_null($this->_hotspotGraphElement))
-            $this->_hotspotGraphElement->processContentAdminUI();
+        parent::processContentAdminUI();
 
         // Name
@@ -535 +523 @@
         $this->setDescription($_REQUEST[$name]);
 
-        if (!is_null($this->_hotspotGraphElement))
-            $this->_hotspotGraphElement->processGraphAdminUI($errMsg);
+        parent::processGraphAdminUI($errMsg);
         if(!empty($errMsg)) {
             echo $errMsg;
@@ -552 +539 @@
 
     /** Add content to this node */
-    public function addContent(Content $content)
+   /* public function addContent(Content $content)
     {
         $db = AbstractDb::getObject();
@@ -559 +546 @@
         $db->execSqlUpdate($sql, false);
         exit;
-    }
+    }*/
 
     /** Remove content from this node */
-    public function removeContent(Content $content)
+  /*  public function removeContent(Content $content)
     {
         $db = AbstractDb::getObject();
@@ -568 +555 @@
         $sql = "DELETE FROM node_has_content WHERE node_id='$this->id' AND content_id='$content_id'";
         $db->execSqlUpdate($sql, false);
-    }
+    }*/
 
 
@@ -634 +621 @@
         $smarty->assign('realNodeLastHeartbeatIP', $node ? $node->getLastHeartbeatIP() : '');
     }
+    
+        /**
+     * Get the type of graph element (read-only for now)
+     * 
+     * @return string
+     */
+    protected function getType() {
+        return 'NodeGroup';
+    }
+  
+    /**
+     * Return whether this element is a root or has parent (Network is root)
+     * @return boolean
+     */
+    public function isRoot(){
+        return false;
+    }
+    
+                /**
+     * Return whether this element is a leaf or has children (Node is leaf)
+     * @return boolean
+     */
+    public function isLeaf() {
+        return false;
+    }
 }
 

trunk/wifidog-auth/wifidog/portal/index.php

@@ -167 +167 @@
 
 // Get all the parent objects of the node
-$parents = HotspotGraph::getAllParents(HotspotGraphElement::getObjectFor($node));
+$parents = HotspotGraph::getAllParents($node);
 
 // Get the contents for all elements parents of and including the node, but exclude user subscribed content if user is known