Changeset 1261

Timestamp:

07/21/07 00:59:33 (6 years ago)

Author:

benoitg

Message:

• At long last, implement #9: Automatic new node creation. When attempting to login from an unknown node, the user (if he has the permissions) will be prompted to create the node, or "steal" en existing one (for hardware swaps).
• Refactor Node:getSelectNodeUI().
• Menu.php: Fix small oversight causing menu not to clear.

Location:

trunk/wifidog-auth

Files:

• CHANGELOG (modified) (1 diff)
• sql/wifidog-postgres-initial-data.sql (modified) (1 diff)
• sql/wifidog-postgres-schema.sql (modified) (2 diffs)
• wifidog/admin/generic_object_admin.php (modified) (2 diffs)
• wifidog/classes/Content/ContentGroup/ContentGroupElement.php (modified) (2 diffs)
• wifidog/classes/Menu.php (modified) (1 diff)
• wifidog/classes/Network.php (modified) (1 diff)
• wifidog/classes/Node.php (modified) (3 diffs)
• wifidog/classes/Security.php (modified) (7 diffs)
• wifidog/classes/Statistics.php (modified) (1 diff)
• wifidog/login/index.php (modified) (1 diff)

trunk/wifidog-auth/CHANGELOG

@@ -1 @@
-# $Id: $
-
+# $Id$
+
+2007-07-20 Benoit Grégoire  <bock@step.polymtl.ca>
+        * At long last, implement #9:  Automatic new node creation.  When attempting to login from an unknown node, the user (if he has the permissions) will be prompted to create the node, or "steal" en existing one (for hardware swaps).
+        * Refactor Node:getSelectNodeUI().
+        * Menu.php:  Fix small oversight causing menu not to clear.
+        
 2007-07-19 Benoit Grégoire  <bock@step.polymtl.ca>
         UIUserList fixes:

trunk/wifidog-auth/sql/wifidog-postgres-initial-data.sql

@@ -215 +215 @@
 --
 
-INSERT INTO schema_info (tag, value) VALUES ('schema_version', '54');
+INSERT INTO schema_info (tag, value) VALUES ('schema_version', '56');
 
 

trunk/wifidog-auth/sql/wifidog-postgres-schema.sql

@@ -532 +532 @@
     is_splash_only_node boolean DEFAULT false,
     custom_portal_redirect_url text,
-    gw_id text NOT NULL
+    gw_id text NOT NULL,
+    last_heartbeat_sys_uptime integer,
+    last_heartbeat_wifidog_uptime integer,
+    last_heartbeat_sys_memfree integer,
+    last_heartbeat_sys_load real
 );
 
@@ -1158 +1162 @@
 
 --
+-- Name: idx_connections_timestamp_in; Type: INDEX; Schema: public; Owner: -; Tablespace: 
+--
+
+CREATE INDEX idx_connections_timestamp_in ON connections USING btree (timestamp_in);
+
+
+--
 -- Name: idx_connections_user_id; Type: INDEX; Schema: public; Owner: -; Tablespace: 
 --

trunk/wifidog-auth/wifidog/admin/generic_object_admin.php

@@ -202 +202 @@
         $html .= _("Node");
         $html .= ": ";
-        $html .= Node :: getSelectNodeUI($name);
+        $html .= Node :: getSelectUI($name);
 
         if (method_exists($object, "getUserUI")) {
@@ -274 +274 @@
             case "Node" :
                 $newLongText = $addLongText;
-                $objectSelector = Node :: getSelectNodeUI('object_id', null, null, null, "table");
+                $userData['typeInterface'] = "table";
+                $objectSelector = Node :: getSelectUI('object_id', $userData);
                 $displayEditButton = false;
                 break;

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

@@ -355 +355 @@
         $html .= "<li class='admin_element_item_container'>\n";
 
-        $sql_additional_where = "AND node_id NOT IN (SELECT node_id FROM content_group_element_has_allowed_nodes WHERE content_group_element_id='$this->id')";
+        $userDataNode['additionalWhere'] = "AND node_id NOT IN (SELECT node_id FROM content_group_element_has_allowed_nodes WHERE content_group_element_id='$this->id')";
         $name = "content_group_element_{$this->id}_new_allowed_node";
-        $html .= Node :: getSelectNodeUI($name, null, $sql_additional_where);
+        $html .= Node :: getSelectUI($name, $userDataNode);
         $name = "content_group_element_{$this->id}_new_allowed_node_submit";
         $html .= "<input type='submit' name='$name' value='" . _("Add new allowed node") . "'>";
@@ -440 +440 @@
         if (!empty ($_REQUEST[$name]) && $_REQUEST[$name] == true) {
             $name = "content_group_element_{$this->id}_new_allowed_node";
-            $node = Node :: processSelectNodeUI($name);
+            $node = Node :: processSelectUI($name);
             $node_id = $node->GetId();
             $db->execSqlUpdate("INSERT INTO content_group_element_has_allowed_nodes (content_group_element_id, node_id) VALUES ('$this->id', '$node_id')", FALSE);

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

@@ -230 +230 @@
         }
         $html .= "</ul>\n";
-                $html .= "<br/ class='clear'>\n";
+                $html .= "<br/ class='clearbr'>\n";
         //echo htmlspecialchars($userData['html']);
         return $html;

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

@@ -221 +221 @@
      *                                     programmer to recognise it's
      *                                     generated html form
-     * @param object $preSelectedObject Network object: The network to be
-     *                                     pre-selected in the form object
-     * @param string $additionalWhere     Additional SQL conditions for the
-     *                                     networks to select
-     * @param string $allowEmpty     boolean Allow not selecting any network
+     * 
+     * @param string $userData=null Array of contextual data optionally sent to the method.
+     *  The function must still function if none of it is present.
+     *
+     * This method understands:
+     *  $userData['preSelectedObject'] An optional object to pre-select.
+     *  $userData['additionalWhere'] Additional SQL conditions for the
+     *                                    objects to select
+     *  $userData['allowEmpty'] boolean Allow not selecting any object
      * @return string HTML markup
 

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

@@ -278 +278 @@
      * @param $user_prefix A identifier provided by the programmer to recognise it's generated html form
      *
-     * @param $sql_additional_where Addidional where conditions to restrict the candidate objects
-     * @param $type_interface:  select, select_multiple or table
-     * @param $selectedNodes; Node object or array of node objects to be pre-selected (not
+     * @param string $userData=null Array of contextual data optionally sent to the method.
+     *  The function must still function if none of it is present.
+     * This method understands:
+     *  $userData['preSelectedObject'] An optional object to pre-select.
+     *  $userData['additionalWhere'] Additional SQL conditions for the
+     *                                    objects to select
+     *  $userData['additionalJoin'] Additional SQL JOIN conditions for the
+     *                                    objects to select
+     *  $userData['preSelectedObjects'] An optional object or array of objects to pre-select. (not
      * supported by type_interface=table)
+     *  $userData['typeInterface'] select, select_multiple or table.  Default is "select"
+     *
      * * @return html markup
      */
-    public static function getSelectNodeUI($user_prefix, $sql_additional_join = null, $sql_additional_where = null,$selectedNodes = null, $type_interface = "select")
-    {
+    public static function getSelectUI($user_prefix, $userData=null)
+    {
+        !empty($userData['additionalJoin'])?$sql_additional_join=$userData['additionalJoin']:$sql_additional_join=null;
+        !empty($userData['additionalWhere'])?$sql_additional_where=$userData['additionalWhere']:$sql_additional_where=null;
+        !empty($userData['preSelectedObjects'])?$selectedNodes=$userData['preSelectedObjects']:$selectedNodes=null;
+        !empty($userData['typeInterface'])?$type_interface=$userData['typeInterface']:$type_interface="select";
+
         $db = AbstractDb::getObject();
         $html = '';
@@ -380 +393 @@
      * @return the node object
      */
-    static function processSelectNodeUI($user_prefix)
+    static function processSelectUI($user_prefix)
     {
         $object = null;
@@ -455 +468 @@
         return $retval;
     }
+
+
+    /** Get an interface to deal with missing nodes.  If the user has the permissions, he will be asked to create a new node for that gateway id, or assign that gateway id to an existing node.
+     * @param $gwId The unknown gwId
+     * @return html markup
+     */
+    public static function getStealOrCreateNewUI($gwId)
+    {
+        $permissionArray[]=array(Permission::P('NETWORK_PERM_EDIT_ANY_NODE_CONFIG'), null);
+        $permissionArray[]=array(Permission::P('NODE_PERM_EDIT_GATEWAY_ID'), null);
+        Security::requireAnyPermission($permissionArray);
+        $db = AbstractDb::getObject();
+        $html = '';
+        $allowedNetworks = Security::getObjectsWithPermission(Permission::P('NETWORK_PERM_EDIT_ANY_NODE_CONFIG'));
+        $allowedNodes = Security::getObjectsWithPermission(Permission::P('NODE_PERM_EDIT_GATEWAY_ID'));
+        $html .= "<p>"._("Here is what you can do to fix this:")."</p>\n";
+        $html .= "<ul>\n";
+        if($allowedNetworks) {
+            //Add a new node for unknown node id
+            $html .= "<li>".sprintf(_("You can create a new node with %s as it's associated gateway id.  This is typical for new installations."), $gwId)."<br/>\n";
+
+            $networkAdditionalWhere=" AND (FALSE\n";
+            foreach ($allowedNetworks as $network) {
+                $idStr = $db->escapeString($network->getId());
+                $networkAdditionalWhere .= " OR network_id='$idStr'\n";
+            }
+            $networkAdditionalWhere .= ")\n";
+            $userData['preSelectedObject']=null;
+            $userData['allowEmpty']=true;
+            $userData['additionalWhere']=$networkAdditionalWhere;
+            $name = "{$gwId}_new_node_network";
+            $networkSelectUI = Network :: getSelectUI($name, $userData);
+            $html .= sprintf(_("Add a new node in %s"), $networkSelectUI)." \n";
+            $name = "{$gwId}_new_node_submit";
+            $value = _("Add node");
+            $html .= "<input type='submit' size='10' name='{$name}' value='$value'>\n";
+            $html .= "</li>\n";
+        }
+
+        if($allowedNetworks || $allowedNodes){
+            //"Steal" an existing node for this ID (typically for hardware replacement)
+            $html .= "<li>".sprintf(_("You can \"steal\" an existing node.  The node's gateway id will be replaced with %s.  This is typical when replacing hardware."), $gwId)."<br/>\n";
+            if($allowedNetworks) {
+                $additionalWhere=$networkAdditionalWhere;
+            }
+            else {
+                $additionalWhere=" AND (FALSE\n";
+                foreach ($allowedNetworks as $network) {
+                    $idStr = $db->escapeString($node->getId());
+                    $additionalWhere .= " OR node_id='$idStr'\n";
+                }
+                $additionalWhere .= ")\n";
+            }
+
+            $userData['preSelectedObject']=null;
+            $userData['allowEmpty']=true;
+            $userData['additionalWhere']=$additionalWhere;
+            $name = "{$gwId}_steal_node";
+            $html .= Node :: getSelectUI($name, $userData);
+            $name = "{$gwId}_steal_node_submit";
+            $value = _("Steal node");
+            $html .= "<input type='submit' size='10' name='{$name}' value='$value'>\n";
+            $html .= "</li>\n";
+        }
+        $html .= "</ul>\n";
+        return $html;
+
+    }
+
+    /**
+     * Process the interface to deal with missing nodes.
+     * @param $gwId The unknown gwId
+     * @param $nodeIsNew Output parameter.  Will be set to true if a new node was created to resolve the situation
+     * @return the created or stolen node object, or null if none was created (or stolen).
+     */
+    public static function processStealOrCreateNewUI($gwId, &$nodeIsNew=null)
+    {
+        // Init values
+        $retval = null;
+        $nodeIsNew = false;
+        $name = "{$gwId}_new_node_submit";
+        if(!empty($_REQUEST[$name])) {
+            //Create new node
+            $name = "{$gwId}_new_node_network";
+            $network = Network :: processSelectUI($name);
+            if($network) {
+                Security::requirePermission(Permission::P('NETWORK_PERM_EDIT_ANY_NODE_CONFIG'), $network);
+                //echo  _("Adding node");
+                $node = Node::createNewObject($gwId, $network);
+                $nodeIsNew = true;
+                $retval = $node;
+            }
+        }
+        $name = "{$gwId}_steal_node_submit";
+        if(!empty($_REQUEST[$name])){
+            //"Steal" an existing node for this ID (typically for hardware replacement)
+            $name = "{$gwId}_steal_node";
+            $node = Node :: processSelectUI($name);
+            if($node) {
+                $permissionArray[]=array(Permission::P('NETWORK_PERM_EDIT_ANY_NODE_CONFIG'), $node->getNetwork());
+                $permissionArray[]=array(Permission::P('NODE_PERM_EDIT_GATEWAY_ID'), $node);
+                Security::requireAnyPermission($permissionArray);
+                //echo _("Stealing node $node");
+                $node->setGatewayId($gwId);
+                $retval = $node;
+            }
+        }
+
+
+        return $retval;
+    }
+
+
 
     /**

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

@@ -76 +76 @@
                 $permission = $permissionsCheck[0];
                 $targetObject = $permissionsCheck[1];
-                $object_class = get_class($targetObject);
-                if($permission->getTargetObjectClass()!=$object_class) {
-                    throw new Exception(sprintf("Tried to check if an object of class %s has a permission of type %s",$object_class, $permission->getTargetObjectClass()));
-                }
-                $table = strtolower($object_class).'_stakeholders';
-                $object_id = $db->escapeString($targetObject->getId());
+                $objectClass = $permission->getTargetObjectClass();
+                if($targetObject) {
+                    if($objectClass!=get_class($targetObject)) {
+                        throw new Exception(sprintf("Tried to check if an object of class %s has a permission of type %s",$objectClass, get_class($targetObject)));
+                    }
+                    $objectId = $db->escapeString($targetObject->getId());
+                    $objectSqlAnd = "\n AND object_id = '$objectId' \n";
+                }
+                else {
+                    $objectSqlAnd = '';
+                }
+                $table = strtolower($objectClass).'_stakeholders';
                 $permissionIdStr = $db->escapeString($permission->getId());
-
-
-                $sqlSelect = "SELECT permission_id FROM $table JOIN role_has_permissions USING (role_id) WHERE object_id = '$object_id' AND user_id='{$user->getId()}' AND permission_id = '$permissionIdStr'";
+                $sqlSelect = "SELECT permission_id FROM $table JOIN role_has_permissions USING (role_id) WHERE user_id='{$user->getId()}' $objectSqlAnd AND permission_id = '$permissionIdStr'";
                 if($operator == 'OR') {
                     $first?$sql .= " ($sqlSelect)\n":$sql .= ", ($sqlSelect)\n";
@@ -122 +126 @@
     /* Check if the current user has the requested permission
      * @param permission The permission to check
-     * @param $targetObject The Object on which the permssion applies (Network, Server, etc.)
-     * @param user User object, optional, if unspecified, the current user is used.  Note that there may be no current user (annonymous)
-     */
-    public static function hasPermission(Permission $permission, $targetObject, $user=null)
+     * @param $targetObject The Object on which the permssion applies (Network, Server, etc.)  If null, the user must have this permission on at least one object
+     * @param user User object, optional, if unspecified, the current user is used.  Note that there may be no current user (annonymous)
+     */
+    public static function hasPermission(Permission $permission, $targetObject=null, $user=null)
     {
         return self::hasPermissionsHelper(array(array($permission, $targetObject)), 'AND', $user);
     }
-    
-        /* Check if the current user has ANY of the requested permission
+
+    /* Check if the current user has ANY of the requested permission
      * @param $permissionsArray An two dimensionnal array of permissions to check
      * permissionsArray[]=array($permission, $targetObject);
@@ -149 +153 @@
         return self::hasPermissionsHelper($permissionsArray, 'AND', $user);
     }
-    
+
     /* require that the user has the current permission, otherwise, throw up an interface to deal with the proplem
      * @param permission The permission to check
-     * @param $targetObject The Object on which the permssion applies (Network, Server, etc.)
-     * @param user User object, optional, if unspecified, the current user is used.  Note that there may be no current user (annonymous)
-     */
-    public static function requirePermission(Permission $permission, $targetObject)
+     * @param $targetObject The Object on which the permission applies (Network, Server, etc.).  If null, the user must have this permission on at least one object
+     * @param user User object, optional, if unspecified, the current user is used.  Note that there may be no current user (annonymous)
+     */
+    public static function requirePermission(Permission $permission, $targetObject=null)
     {
         $hasPermission = self::hasPermission($permission, $targetObject, User::getCurrentUser());
@@ -177 +181 @@
         return true;
     }
-    
+
     /* Require that the user has ALL of the requested permissions
      * @param $permissionsArray A two dimensionnal array of permissions to check
@@ -191 +195 @@
         return true;
     }
-    
+
     private static function handleMissingPermissions(Array $permissionsArray)
     {
@@ -199 +203 @@
             $targetObject = $permissionsCheck[1];
             if(!self::hasPermission($permission, $targetObject)) {
-                $missingPerms .= sprintf(_("%s (%s) on  %s object %s")."<br/>\n", $permission->getId(), $permission->getDescription(), get_class($targetObject), (string)$targetObject);
+                $missingPerms .= sprintf(_("%s (%s) on  %s: %s")."<br/>\n", $permission->getId(), $permission->getDescription(), $permission->getTargetObjectClass(), $targetObject?(string)$targetObject:_('Any'));
             }
         }
@@ -205 +209 @@
         throw new SecurityException($msg);
     }
-    
+
     /* Returns an array of objects for which the user has the specified permission
      * @param permission The permission to check

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

@@ -387 +387 @@
         $selectedNodes = $this->getSelectedNodes();
         $sql = "SELECT nodes.node_id, nodes.name from nodes $sql_join WHERE 1=1 ORDER BY lower(nodes.node_id)";
-        $html .= Node :: getSelectNodeUI($name, $sql_join, null, $selectedNodes, "select_multiple");
+        $userData['preSelectedObjects']=$selectedNodes;
+                $userData['sqlJoin']=$sql_join;
+                                $userData['typeInterface']="select_multiple";
+        $html .= Node :: getSelectUI($name, $userData);
         return $html;
     }

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

@@ -132 +132 @@
     try {
         $node = Node::getObjectByGatewayId($gw_id);
-        if($node)
-        {
-            $session->set(SESS_NODE_ID_VAR, $node->getId());
+    }
+
+    catch (Exception $e) {
+        $returnedNodeIsNew = false;
+        $node = Node::processStealOrCreateNewUI($gw_id, $returnedNodeIsNew);
+
+        if(!$node){
+            $ui = MainUI::getObject();
+            $ui->addContent('main_area_middle', '<p class=errormsg>'.$e->getMessage()."</p>\n", 1);
+            $stealNodeForm=null;
+            $stealNodeForm.="<form action='' method='POST'>\n";
+            $stealNodeForm.=Node::getStealOrCreateNewUI($gw_id);
+            $stealNodeForm.="</form>\n";
+            $ui->addContent('main_area_middle',$stealNodeForm,2);
+            $ui->display();
+            exit;
         }
-    }
-
-    catch (Exception $e) {
-        $ui = MainUI::getObject();
-        $ui->displayError($e->getMessage());
-        exit;
-    }
-
+        else {
+            if($returnedNodeIsNew) {
+                $url = BASE_URL_PATH."admin/generic_object_admin.php?object_class=Node&action=edit&object_id=".$node->getId();
+                header("Location: {$url}");
+                exit;
+            }
+        }
+    }
+    if($node)
+    {
+        $session->set(SESS_NODE_ID_VAR, $node->getId());
+    }
     $network = $node->getNetwork();
 } else {