Changeset 1453

Timestamp:

02/25/10 15:56:33 (2 years ago)

Author:

gbastien

Message:

• Added possibility to have a deployed geolocated node not show on map (quick fix) (#706)
• When producing anonymised data export, two files are produced, one for the geolocated nodes and one for the connections (#705)
• Additions and bug fixes to web service: can now logout and auth returns both error code and message
• Starting work on #707 as needed

Location:

trunk/wifidog-auth

Files:

• CHANGELOG (modified) (1 diff)
• wifidog/admin/stats.php (modified) (1 diff)
• wifidog/classes/Authenticators/AuthenticatorLocalUser.php (modified) (4 diffs)
• wifidog/classes/Node.php (modified) (3 diffs)
• wifidog/classes/NodeLists/NodeListXML.php (modified) (1 diff)
• wifidog/classes/StatisticReport/AnonymisedDataExport.php (modified) (1 diff)
• wifidog/classes/User.php (modified) (3 diffs)
• wifidog/include/common.php (modified) (1 diff)
• wifidog/include/schema_validate.php (modified) (2 diffs)
• wifidog/js/hotspots_status_map.js (modified) (1 diff)
• wifidog/ws/classes/WifidogWS/V1.php (modified) (8 diffs)
• wifidog/ws/index.php (modified) (1 diff)

trunk/wifidog-auth/CHANGELOG

@@ -1 +1 @@
 # $Id$
+
+2010-02-25 Geneviève Bastien <gbastien@versatic.net>
+ * Added constraint to hotspot_graph_element_has_content (#701)
+ * Bug fix: when creating new nodes and node groups, they are now automatically added as children of the network in the new hierarchy structure.
+ * Added possibility to have a deployed geolocated node not show on map (quick fix) (#706)
+ * When producing anonymised data export, two files are produced, one for the geolocated nodes and one for the connections (#705)
+ * Additions and bug fixes to web service: can now logout and auth returns both error code and message
+ * Starting work on #707 as needed
 
 2010-01-28 Geneviève Bastien <gbastien@versatic.net>

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

@@ -83 +83 @@
                 $stats_title = _("Network information for")." '".$networkObject->getName()."'";
         }
+        elseif (isset($_REQUEST['file']) && isset($_REQUEST['type'])) {
+            $filename = $_REQUEST['file'];
+            $type = $_REQUEST['type'];
+            if (User :: getCurrentUser()->DEPRECATEDisSuperAdmin())  {
+            // The file is valid for one hour, because it contains sensitive data and we don't want to open a security breach
+            if (file_exists($filename) && (filectime($filename) > (time() - 60*60)) ) {
+                header('Content-Type: application/octet-stream');
+              header('Content-Disposition: inline; filename="anonymised_'.$type.'.sql"');
+              header("Content-Transfer-Encoding: binary");
+              header("Pragma: no-cache");
+              header("Expires: 0");
+              $fp=fopen($filename,"r");
+              print fread($fp,filesize($filename));
+              fclose($fp);
+              exit();
+            } else {
+                if (!file_exists($filename)) {
+                    throw new Exception(sprintf(_("File %s does not exist"),  $filename));
+                }
+                if (filectime($filename) > (time() - 60*60)) {
+                    throw new Exception(sprintf(_("The statistics file for anonymised_%s.sql has expired."), $type));
+                }
+            }
+            } else {
+                throw new Exception(_("These reports are only available to server administrators."));
+            }
+        }
         else {
             $stats_title = null;

trunk/wifidog-auth/wifidog/classes/Authenticators/AuthenticatorLocalUser.php

@@ -101 +101 @@
      * @param string $password Clear text password.
      * @param string $errmsg   Reference of error message
+     * @param int $errno       Reference to error code
      *
      * @return object The actual User object if login was successfull, false
      *                otherwise.
      */
-    public function login($username, $password, &$errmsg = null)
+    public function login($username, $password, &$errmsg = null, &$errno = 0)
     {
         //echo "DEBUG:  login($username, $password, $errmsg)<br/>";
@@ -115 +116 @@
         $username = $db->escapeString($username);
         if (empty($username)) {
-            $errmsg .= sprintf(_("Fatal error:  Username cannot be empty"));
+            $errmsg .= sprintf(getErrorText(ERR_NO_USERNAME));
+            $errno = ERR_NO_USERNAME;
             $retval = false;
         }
@@ -131 +133 @@
                 $user = User::getObject($user_info['user_id']);
 
-                if ($user->isUserValid($errmsg)) {
+                if ($user->isUserValid($errmsg, $errno)) {
                     $retval = &$user;
                     $errmsg = _("Login successfull");
@@ -147 +149 @@
 
                 if ($user_info == null) {
-                    $errmsg = _('Unknown username or email');
+                    $errmsg = getErrorText(ERR_UNKNOWN_USERNAME);
+                    $errno = ERR_UNKNOWN_USERNAME;
                 } else {
-                    $errmsg = _('Incorrect password (Maybe you have CAPS LOCK on?)');
+                    $errmsg = getErrorText(ERR_WRONG_PASSWORD);
+                    $errno = ERR_WRONG_PASSWORD;
                 }
 

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

@@ -825 +825 @@
         $this->refresh();
     }
-
+    
+    /**
+     * Returns whether the node should be shown on a map or is invisible
+     *
+     */
+
+    public function showOnMap()
+    {
+        return (($this->_row['show_node_on_map'] == 't') ? true : false);
+    }
+
+    /** Set if this node be shown on map
+     * @param $value The new value, true or false
+     * @return true on success, false on failure */
+    function setShowOnMap($value)
+    {
+        $retval = true;
+        if ($value != $this->showOnMap())
+        {
+            $db = AbstractDb::getObject();
+            $value ? $value = 'TRUE' : $value = 'FALSE';
+            $retval = $db->execSqlUpdate("UPDATE nodes SET show_node_on_map = {$value} WHERE node_id = '{$this->getId()}'", false);
+            $this->refresh();
+        }
+        return $retval;
+    }
+    
     public function getCivicNumber()
     {
@@ -1307 +1333 @@
         $_data = InterfaceElements::generateInputText("node_" . $node_id . "_map_url", $this->getMapURL(), "node_map_url_input");
         $_html_node_gis_data[] = InterfaceElements::generateAdminSectionContainer("node_map_url", $_title, $_data);
+        
+        $_title = _("Show node on map");
+        $help = _("Should this node be visible on the map when deployed?");
+        $_data = InterfaceElements::generateInputCheckbox("node_" . $node_id . "_show_on_map", "", _("Yes"), $this->showOnMap(), "node_show_on_map_input");
+        $_html_node_gis_data[] = InterfaceElements::generateAdminSectionContainer("node_show_on_map", $_title, $_data, $help);
 
         // Build section
@@ -1509 +1540 @@
             $this->setGisLocation(new GisPoint($_REQUEST[$gis_lat_name], $_REQUEST[$gis_long_name], .0));
         }
+        
+        $name = "node_".$node_id."_show_on_map";
+        $this->setShowOnMap(empty ($_REQUEST[$name]) ? false : true);
 
         // Statistics

trunk/wifidog-auth/wifidog/classes/NodeLists/NodeListXML.php

@@ -331 +331 @@
                     $_hotspotGis->setAttribute("lat", $_gisData->getLatitude());
                     $_hotspotGis->setAttribute("long", $_gisData->getLongitude());
+                    $_hotspotGis->setAttribute("show", $_node->showOnMap());
                     $_hotspot->appendChild($_hotspotGis);
                 }

trunk/wifidog-auth/wifidog/classes/StatisticReport/AnonymisedDataExport.php

@@ -99 +99 @@
         else
         {
-            header('Content-Type: application/octet-stream');
-            header('Content-Disposition: inline; filename="anonymised_data.sql"');
-            header("Content-Transfer-Encoding: binary");
-
-            $html  .= <<<EOT
-            CREATE TABLE connections_anonymised
-            (
-            conn_id text NOT NULL,
-            timestamp_in timestamp,
-            node_id text,
-            timestamp_out timestamp,
-            user_id text NOT NULL DEFAULT '',
-            user_mac text,
-            incoming int8,
-            outgoing int8
-            );
+            /** Starting   sql file with geolocation data */
+            $tmpdir = sys_get_temp_dir();
+            $nodefile = tempnam($tmpdir, 'wd');
+            $nfilehndl = fopen($nodefile, 'w');
+            $datafile = tempnam($tmpdir, 'wd');
+            $datahndl = fopen($datafile, 'w');
+            
+            if (!$nfilehndl || !$datahndl) {
+                $html .= "<p class='error'>"._("Could not create files for anonymised data")."</p>";
+                
+            } else {
+                /* header('Content-Type: application/octet-stream');
+                header('Content-Disposition: inline; filename="anonymised_nodes.sql"');
+                header("Content-Transfer-Encoding: binary"); */
+                
+                $text  = <<<EOT
+                CREATE TABLE nodes_anonymised
+                (
+                node_id text NOT NULL,
+                latitude  NUMERIC(16, 6),
+                longitude  NUMERIC(16, 6)
+                );
 EOT;
-$html .= "\n";
-            echo $html;
-            $distinguish_users_by = $this->stats->getDistinguishUsersBy();
-
-            $candidate_connections_sql = $this->stats->getSqlCandidateConnectionsQuery("conn_id, users.user_id, nodes.node_id, connections.user_id, user_mac, timestamp_in, timestamp_out, incoming, outgoing ", true);
-
-            $sql = "$candidate_connections_sql ORDER BY timestamp_in DESC";
-            $db->execSqlRaw($sql, $resultHandle, false);
-            if($resultHandle) {
-                while($row=pg_fetch_array($resultHandle,null,PGSQL_ASSOC))
-                {
-
-                    $keys = null;
-                    $values = null;
-                    $first = true;
-                    foreach ($row as $key=>$value)
+                $text .= "\n";
+    
+                fwrite($nfilehndl, $text);
+                
+                $node_constraint = $this->stats->getSqlNodeConstraint('nodes.node_id');
+                $network_constraint = $this->stats->getSqlNetworkConstraint('nodes.network_id');
+                $sql = "SELECT node_id, latitude, longitude \n";
+                $sql .= "FROM nodes \n";
+                $sql .= "WHERE 1=1 {$node_constraint} {$network_constraint}";
+                
+                $db->execSql($sql, $nodes);
+                
+                if ($nodes) {
+                    foreach($nodes as $row) {
+                        $keys = null;
+                        $values = null;
+                        $first = true;
+                        foreach ($row as $key=>$value)
+                        {
+                            if($key == 'user_id' || $key == 'node_id' || $key == 'conn_id' || $key == 'user_mac' ) {
+                                $value = "'".$this->getNonRepeatableHash($value)."'";
+                            }
+                            else if ($key == 'latitude' && empty ($value)) {
+                                $value = 'NULL';
+                            }
+                            else if ($key == 'longitude' && empty ($value)) {
+                                $value = 'NULL';
+                            }
+                            else {
+                                $value = "'$value'";
+                            }
+                            if(!$first) {
+                                $keys .= ', ';
+                                $values .= ', ';
+                            }
+                            else {
+                                $first = false;
+                            }
+                            $keys .= $key;
+                            $values .= $value;
+                        }
+                        //fwrite($temp, "INSERT INTO connections_anonymised ($keys) VALUES ($values);\n");
+                        fwrite($nfilehndl, "INSERT INTO nodes_anonymised ($keys) VALUES ($values);\n");
+                    }
+                }
+                
+                
+                /** End sql file with node data */
+                
+                /** Get the sql file with anonymised connection data */
+              /*  header('Content-Type: application/octet-stream');
+                header('Content-Disposition: inline; filename="anonymised_data.sql"');
+                header("Content-Transfer-Encoding: binary");*/
+    
+                $text = <<<EOT
+                CREATE TABLE connections_anonymised
+                (
+                conn_id text NOT NULL,
+                timestamp_in timestamp,
+                node_id text,
+                timestamp_out timestamp,
+                user_id text NOT NULL DEFAULT '',
+                user_mac text,
+                incoming int8,
+                outgoing int8
+                );
+EOT;
+                $text .= "\n";
+            
+                fwrite($datahndl,  $text);
+                $distinguish_users_by = $this->stats->getDistinguishUsersBy();
+    
+                $candidate_connections_sql = $this->stats->getSqlCandidateConnectionsQuery("conn_id, users.user_id, nodes.node_id, connections.user_id, user_mac, timestamp_in, timestamp_out, incoming, outgoing ", true);
+    
+                $sql = "$candidate_connections_sql ORDER BY timestamp_in DESC";
+                $db->execSqlRaw($sql, $resultHandle, false);
+                if($resultHandle) {
+                    while($row=pg_fetch_array($resultHandle,null,PGSQL_ASSOC))
                     {
-                        if($key == 'user_id' || $key == 'node_id' || $key == 'conn_id' || $key == 'user_mac' ) {
-                            $value = "'".$this->getNonRepeatableHash($value)."'";
+    
+                        $keys = null;
+                        $values = null;
+                        $first = true;
+                        foreach ($row as $key=>$value)
+                        {
+                            if($key == 'user_id' || $key == 'node_id' || $key == 'conn_id' || $key == 'user_mac' ) {
+                                $value = "'".$this->getNonRepeatableHash($value)."'";
+                            }
+                            else if ($key == 'timestamp_out' && empty ($value)) {
+                                $value = 'NULL';
+                            }
+                            else {
+                                $value = "'$value'";
+                            }
+                            if(!$first) {
+                                $keys .= ', ';
+                                $values .= ', ';
+                            }
+                            else {
+                                $first = false;
+                            }
+                            $keys .= $key;
+                            $values .= $value;
                         }
-                        else if ($key == 'timestamp_out' && empty ($value)) {
-                            $value = 'NULL';
-                        }
-                        else {
-                            $value = "'$value'";
-                        }
-                        if(!$first) {
-                            $keys .= ', ';
-                            $values .= ', ';
-                        }
-                        else {
-                            $first = false;
-                        }
-                        $keys .= $key;
-                        $values .= $value;
+                        //fwrite($temp, "INSERT INTO connections_anonymised ($keys) VALUES ($values);\n");
+                        fwrite($datahndl, "INSERT INTO connections_anonymised ($keys) VALUES ($values);\n");
                     }
-                    //fwrite($temp, "INSERT INTO connections_anonymised ($keys) VALUES ($values);\n");
-                    echo "INSERT INTO connections_anonymised ($keys) VALUES ($values);\n";
                 }
+                fclose($datahndl);
+                fclose($nfilehndl);
+                
+                $html .= <<<EOS
+                <script type="text/javascript">
+                                window.open('/admin/stats.php?file=$nodefile&type=node', 'Node File');
+                                window.open('/admin/stats.php?file=$datafile&type=data', 'Data file');
+                                                                </script>
+EOS;
+                
+                
             }
-            exit;
         }
         return $html;

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

@@ -516 +516 @@
 
     /** Is the user valid?  Valid means that the account is validated or hasn't exhausted it's validation period.
-     $errmsg: Returs the reason why the account is or isn't valid */
-    function isUserValid(& $errmsg = null) {
+     $errmsg: Returs the reason why the account is or isn't valid
+     $errno: Returns an error code identifying the error */
+    function isUserValid(& $errmsg = null, &$errno = 0) {
         global $account_status_to_text;
         $db = AbstractDb::getObject();
@@ -530 +531 @@
 
             if ($user_info['validation_grace_time_expired'] == 't') {
-                $errmsg = sprintf(_("Sorry, your %.0f minutes grace period to retrieve your email and validate your account has now expired. You will have to connect to the internet and validate your account from another location."), $user_info['validation_grace_time']/60);
+                $errmsg = sprintf(getErrorText(ERR_VALIDATION_EXPIRED), $user_info['validation_grace_time']/60);
+                $errno = ERR_VALIDATION_EXPIRED;
                 $retval = false;
             } else {
@@ -537 +539 @@
             }
         } else {
-            $errmsg = _("Sorry, your account is not valid: ") . $account_status_to_text[$account_status];
+            $errmsg = getErrorText(ERR_ACCOUNT_INVALID) . $account_status_to_text[$account_status];
+            $errno = ERR_ACCOUNT_INVALID;
             $retval = false;
         }

trunk/wifidog-auth/wifidog/include/common.php

@@ -158 +158 @@
 /* End of Other constants */
 
+/* defin error codes */
+define ('ERR_UNKNOWN_USERNAME', 20001);
+define ('ERR_WRONG_PASSWORD', 20002);
+define ('ERR_NO_USERNAME', 20003);
+define ('ERR_VALIDATION_EXPIRED', 20004);
+define ('ERR_ACCOUNT_INVALID', 20005);
+
+function getErrorText($errorCode) {
+    switch ($errorCode) {
+        case ERR_UNKNOWN_USERNAME: $text = _('Unknown username or email'); break;
+        case ERR_WRONG_PASSWORD: $text = _('Incorrect password (Maybe you have CAPS LOCK on?)'); break;
+        case ERR_NO_USERNAME: $text = _("Fatal error:  Username cannot be empty"); break;
+        case ERR_VALIDATION_EXPIRED: $text = _("Sorry, your %.0f minutes grace period to retrieve your email and validate your account has now expired. You will have to connect to the internet and validate your account from another location."); break;
+        case ERR_ACCOUNT_INVALID: $text = _("Sorry, your account is not valid: "); break;
+        default: $text = $errorCode; break;
+    }
+    return $text;
+}
+/* End error code definitions */
+
 /** Convert a password hash form a NoCat passwd file into the same format as get_password_hash().
  * @return The 32 character hash.

trunk/wifidog-auth/wifidog/include/schema_validate.php

@@ -48 +48 @@
  * Define current database schema version
  */
-define('REQUIRED_SCHEMA_VERSION', 69);
+define('REQUIRED_SCHEMA_VERSION', 70);
 /** Used to test a new shecma version before modyfying the database */
 define('SCHEMA_UPDATE_TEST_MODE', false);
@@ -1534 +1534 @@
         $sql .= "\n\nALTER TABLE hotspot_graph_element_has_content ADD CONSTRAINT contentfk FOREIGN KEY (content_id) REFERENCES content(content_id) ON UPDATE CASCADE ON DELETE CASCADE;\n";
     }
+    
+    $new_schema_version = 70;
+    if ($schema_version < $new_schema_version && $new_schema_version <= $targetSchema) {
+        printUpdateVersion($new_schema_version);
+        $sql .= "\n\nUPDATE schema_info SET value='$new_schema_version' WHERE tag='schema_version';\n";
+        $sql .= "\nALTER TABLE nodes ADD COLUMN show_node_on_map boolean NOT NULL DEFAULT true;";
+    }
    
     /*

trunk/wifidog-auth/wifidog/js/hotspots_status_map.js

@@ -321 +321 @@
         var gis = hotspots[i].getElementsByTagName("gisCenterLatLong");
 
-        if (hotspotId.length == 1 && gis.length == 1 && gis[0].getAttribute("lat") != "" && gis[0].getAttribute("long") != "") {
+        if (hotspotId.length == 1 && gis.length == 1 && gis[0].getAttribute("lat") != "" && gis[0].getAttribute("long") != "" && gis[0].getAttribute("show") == "1") {
             // Extract GIS data
             var point = new GLatLng(parseFloat(gis[0].getAttribute("lat")), parseFloat(gis[0].getAttribute("long")));

trunk/wifidog-auth/wifidog/ws/classes/WifidogWS/V1.php

@@ -103 +103 @@
                         'NumOnlineUsers' => 'NumOnlineUsers',
                         'CreationDate' => 'CreationDate',
-                        'Status' => 'Status',
+                        'Status' => 'DeploymentStatus',
                         'OpeningDate' => 'CreationDate', 
                                                                         'Connected_users' => 'OnlineUsers'),
@@ -150 +150 @@
         foreach($infields as $field) {
             if (isset(self::$_allowedFields[$objectClass][$field]))
-                $fields[] = self::$_allowedFields[$objectClass][$field];
+                $fields[$field] = self::$_allowedFields[$objectClass][$field];
             else
-                $fields[] = "$field.forbidden";
+                $fields[$field] = "$field.forbidden";
         }
         return $fields;
@@ -189 +189 @@
                 $username = (isset($this->_params['username']) ? $this->_params['username']:'');
                 $password = (isset($this->_params['password']) ? $this->_params['password']:'');
-                $this->executeAuth($username, $password, $gw_id, $gw_address, $mac, $gw_port, $from);
+                $logout = (isset($this->_params['logout']) ? $this->_params['logout']:false);
+                $this->executeAuth($username, $password, $gw_id, $gw_address, $mac, $gw_port, $from, $logout);
                 break;
             default:
@@ -204 +205 @@
      * @param $gw_id      The gateway id
      * @param $gw_ip      The gateway's ip addresss
+     * @param $mac                        The mac address of the user
+     * @param $gw_port    The port of the gateway's http server
+     * @param $from                     The ip address of the user on the node
+     * @param $logout                   Whether the user wants to logout
      * @return unknown_type
      */
-    protected function executeAuth($username = null, $password = null, $gw_id = null, $gw_ip = null, $mac = null, $gw_port = null, $from = null) {
+    protected function executeAuth($username = null, $password = null, $gw_id = null, $gw_ip = null, $mac = null, $gw_port = null, $from = null, $logout = false) {
         $this->_outputArr['auth'] = 0;
         
@@ -240 +245 @@
             if (!$token) throw new WSException("User authenticated but cannot generate connection token.", WSException::PROCESS_ERROR);
         } else {
-            // Authenticate the user on the requested network
-            $user = $network->getAuthenticator()->login($username, $password, $errMsg);
-            if (!$user) {
-                $this->_outputArr['auth'] = 0;
-                $this->_outputArr['explanation'] = $errMsg;
+            if (!$logout) {
+                // Authenticate the user on the requested network
+                $user = $network->getAuthenticator()->login($username, $password, $errMsg, $errNo);
+                if (!$user) {
+                    $this->_outputArr['auth'] = 0;
+                    $this->_outputArr['explanation'] = $errMsg;
+                    $this->_outputArr['errorcode'] = $errNo;
+                } else {
+                    $this->_outputArr['auth'] = 1;
+                    if (!is_null($node)) {
+                        $token = $user->generateConnectionTokenNoSession($node, $from, $mac);
+                       
+                        if (!$token) throw new WSException("User authenticated but cannot generate connection token.", WSException::PROCESS_ERROR);
+                    }
+                }
             } else {
+                $user = User::getUserByUsernameOrEmail($username);
+                User::setCurrentUser($user);
+                $network->getAuthenticator()->logout();
                 $this->_outputArr['auth'] = 1;
-                if (!is_null($node)) {
-                    $token = $user->generateConnectionTokenNoSession($node, $from, $mac);
-                   
-                    if (!$token) throw new WSException("User authenticated but cannot generate connection token.", WSException::PROCESS_ERROR);
-                }
             }
         }
@@ -298 +311 @@
         $fields = $this->mapFields($objectClass, $fields);
         if (empty($fields)) {
-            $fields = array_keys(self::$_allowedFields[$objectClass]);
+            $fields = self::$_allowedFields[$objectClass];
         } 
         $allowedFields = self::$_allowedFields[$objectClass];
@@ -362 +375 @@
         } 
 
+        if (!isset($objectList)) {
+            throw new WSException("Object list for '{$objectClass}' is not supported.", WSException::GENERIC_EXCEPTION);
+        }
         $this->_outputArr = self::filterRet($objectList, $fields);
     }
@@ -389 +405 @@
                     }
                     $retFields = array();
-                    foreach ($fields as $field) {
+                    foreach ($fields as $fkey => $field) {
                         $forbiddenfield = explode(".", $field);
                         if (! (count($forbiddenfield) == 2)) {
                             $methodName = 'get'.$field;
                             if (method_exists($value, $methodName)) {
-                                
-                                $retFields[$field] = self::filterRet($value->$methodName());
+                                $retFields[is_string($fkey)?$fkey:$field] = self::filterRet($value->$methodName());
                             } else {
-                                $retFields[$field] = 'unknown';
+                                $retFields[is_string($fkey)?$fkey:$field] = 'unknown';
                             }
                         } else

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

@@ -71 +71 @@
  */
 require_once('../include/common.php');
+require_once('../include/language.php');
 require_once('ws/classes/WifidogWS.php');
 require_once('ws/classes/WSOutput.php');