hotspotlogin 0.1.2 → 1.0.0

data/public/hotspotlogin/js/UserStatus.js

@@ -0,0 +1,229 @@
+// Requires ChilliLibrary.js
+// See: http://www.coova.org/CoovaChilli/JSON
+//
+// Copyright(c) 2010, Guido De Rosa (guido.derosa at vemarsas.it) . 
+// License: MIT
+
+chilliController.sessionTimeLeft = function() {
+  return Math.max(
+    (
+      chilliController.session.sessionTimeout -
+      chilliController.accounting.sessionTime
+    ),
+    0
+  );
+}
+chilliController.idleTimeLeft = function() {
+  return Math.max(
+    (
+      chilliController.session.idleTimeout -
+      chilliController.accounting.idleTime
+    ),
+    0
+  );
+}
+
+chilliController.scheduleSessionTimeoutAutorefresh = function() {
+  if (chilliController.sessionTimeLeft() && !chilliController.sessionTimeoutTimer) {
+    chilliController.sessionTimeoutTimer = {
+      preLogoff:  setTimeout(
+        'chilliController.refresh()', 1000 * chilliController.sessionTimeLeft()
+      ),
+      atLogoff:   setTimeout( // 3 seconds delay looks fair
+        'chilliController.refresh()', 1000 * (3 + chilliController.sessionTimeLeft())
+      )
+    }
+  }
+}
+
+chilliController.scheduleIdleTimeoutAutorefresh = function() {
+  if (chilliController.idleTimeLeft()) {
+    if (chilliController.idleTimeoutTimer) {
+      clearTimeout(chilliController.idleTimeoutTimer.preLogoff);
+      clearTimeout(chilliController.idleTimeoutTimer.atLogoff);
+    }  
+    chilliController.idleTimeoutTimer = {
+      preLogoff:  setTimeout(
+        'chilliController.refresh()', 1000 * chilliController.idleTimeLeft()
+      ),
+      atLogoff:   setTimeout( // 3 seconds delay looks fair
+        'chilliController.refresh()', 1000 * (3 + chilliController.idleTimeLeft())
+      )
+    }
+  }
+}
+
+function showUserStatus(h) {
+
+  // Utility functions and objects
+  //
+  function formatStateCode(code) {
+    switch(code) {
+      case chilliController.stateCodes.UNKNOWN:
+        return 'Unknown';
+      case chilliController.stateCodes.NOT_AUTH:
+        return 'Not Authorized';
+      case chilliController.stateCodes.AUTH:
+        return 'Authorized';
+      case chilliController.stateCodes.AUTH_PENDING:
+        return 'Authorization Pending';
+      case chilliController.stateCodes.AUTH_SPLASH:
+        return 'AUTH_SPLASH'; // What does it mean?
+      default:
+        return code;
+    }
+  }
+
+  // CoovaChilli JSON interface only supports CHAP... don't use JSON to login.
+  function loginURL() {
+    var schema = chilliController.ssl ? 'https' : 'http';
+    return schema + '://' + h.uamip + ':' + h.uamport;
+  }
+  
+  // chilliController.debug = true;
+
+  // If you use non standard configuration, define your configuration
+  if (h.uamip)
+    chilliController.host = h.uamip;    // default: 192.168.182.1
+  if (h.uamport)
+    chilliController.port = h.uamport;  // default: 3990 
+
+  // We choose 5 minutes because is the default interval of Chilli->Radius
+  // accounting updates, and looks reasonable for busy sites (avoiding too
+  // much load on the network infrastructure and servers) .
+  chilliController.interval = (h.interval || 300);  // default = 30
+
+  // then define event handler functions
+  chilliController.onError  = handleErrors;
+  chilliController.onUpdate = updateUI ;
+
+  // get current state
+  chilliController.refresh() ;
+
+  initTable();
+
+  function initTable() {
+    // show them when/if we need them; but do not hide them when 
+    // session terminates
+    document.getElementById('sessionTimeLeft:row').style.display  = 'none';
+    document.getElementById('idleTimeout:row').style.display      = 'none';
+  }
+
+  function updateHeadings(clientState) {
+    txt = null;
+    switch(clientState) {
+      case chilliController.stateCodes.NOT_AUTH:
+        txt = 'Logged out from HotSpot';
+        break;
+      case chilliController.stateCodes.AUTH:
+        txt = 'Logged in to HotSpot';
+        break;
+    }
+    if (txt) {
+      document.title = txt;
+      if (document.getElementById('headline')) 
+        document.getElementById('headline').innerHTML = txt;
+    }
+  }
+
+  function updateLinks(clientState) {
+    var e = document.getElementById('logInLogOut');
+    if (e) {
+      switch(clientState) {
+        case chilliController.stateCodes.NOT_AUTH:
+          e.setAttribute('href', loginURL());
+          e.innerHTML = 'Login';
+          break;
+        case chilliController.stateCodes.AUTH:
+          e.setAttribute('href', '#');
+          e.onclick = chilliController.logoff; 
+          e.innerHTML = 'Logout';
+          break;
+      }
+    }
+  }
+
+  // when the reply is ready, this handler function is called
+  function updateUI( cmd ) {
+    updateHeadings( chilliController.clientState);
+    updateLinks(    chilliController.clientState);
+    var userName_e        = document.getElementById('userName');
+    var clientState_e     = document.getElementById('clientState');
+    var sessionTime_e     = document.getElementById('sessionTime');
+    var sessionTimeLeft_e = document.getElementById('sessionTimeLeft');
+    var download_e        = document.getElementById('download');
+    var upload_e          = document.getElementById('upload');
+    var interval_e        = document.getElementById('interval');
+    if (userName_e) {
+      userName_e.innerHTML = (
+          chilliController.session.userName
+      );
+    }
+    if (clientState_e) {
+      clientState_e.innerHTML = (
+        formatStateCode(chilliController.clientState) 
+      );
+    }
+    //if (chilliController.terminateCause) {
+    //  document.getElementById('terminateCause').innerHTML = (
+    //    chilliController.terminateCause
+    //  )
+    //}
+    if (sessionTime_e) {
+      document.getElementById('sessionTime').innerHTML = (
+        chilliController.formatTime(
+          chilliController.accounting.sessionTime, '0')
+      );
+    }
+    if (sessionTimeLeft_e) {
+      if (chilliController.session.sessionTimeout) {
+        document.getElementById('sessionTimeLeft').innerHTML = (
+          chilliController.formatTime(chilliController.sessionTimeLeft(), 0) 
+        );
+        document.getElementById('sessionTimeLeft:row').style.display = '';
+      } else {
+        document.getElementById('sessionTimeLeft').innerHTML = ''
+      }
+    }
+    if (chilliController.session.idleTimeout) {
+      document.getElementById('idleTimeout').innerHTML = (
+          chilliController.formatTime(chilliController.accounting.idleTime) +
+          ' / '                                                             +
+          chilliController.formatTime(chilliController.session.idleTimeout)
+      );
+      document.getElementById('idleTimeout:row').style.display = '';
+    }
+    var download_bytes = 
+      chilliController.accounting.inputOctets +
+      Math.pow(2, 32) * chilliController.accounting.inputGigawords; 
+    var upload_bytes = 
+      chilliController.accounting.outputOctets +
+      Math.pow(2, 32) * chilliController.accounting.outputGigawords;    
+    if (download_e) {
+      download_e.innerHTML = (
+        chilliController.formatBytes(download_bytes, 0)
+      );
+    }
+    if (upload_e) {
+      upload_e.innerHTML = (
+        chilliController.formatBytes(upload_bytes, 0)
+      );
+    }
+    if (interval_e) {
+      interval_e.innerHTML = (
+        chilliController.formatTime(chilliController.interval, 0)
+      );
+    }
+    
+    chilliController.scheduleSessionTimeoutAutorefresh();
+    chilliController.scheduleIdleTimeoutAutorefresh();
+  }
+
+  // If an error occurs, this handler will be called instead
+  function handleErrors ( code ) {
+    alert('The last contact with the Controller failed. Error code =' + code);
+  }
+
+
+}
+

data/views/_login_form.erb

@@ -6,14 +6,16 @@
   <table>
     <tbody>
       <tr>
-        <td>Login:</td>
+        <th scope="row">Login:</td>
         <td><input type="text" name="UserName" size="20" maxlength="255"></td>
       </tr>
       <tr>
-        <td>Password:</td>
+        <th scope="row">Password:</td>
         <td><input type="password" name="Password" size="20" maxlength="255"></td>
       </tr>
     </tbody>
   </table>
-  <input type="submit" name="login" value="login">
+  <div id="submit-container">
+    <input type="submit" name="login" value="login">
+  </div>
 </form>

data/views/hotspotlogin.erb

@@ -1,22 +1,36 @@
-<h1><%= titel %></h1>
+<%
+  require 'hotspotlogin/app/helpers'
+%>
+
+<% if custom_headline %>
+  <h1><%= custom_headline %></h1>
+<% end %>
+<% if logoext %>
+  <div id="logo-container"><img src="/hotspotlogin/logo<%= logoext %>"/></div>
+<% end %>
+
+<h2 id="headline"><%= titel %></h2>
+
+<% if custom_text and File.file? custom_text %>
+  <div id="custom-text"><%= File.read custom_text %></div>
+<% end %>
+
+<%# TODO: use constants.rb %> 
 <% if [1, 4, 12].include? result %>
-  <div style="text-align: center;">
-    <a href="http://<%= uamip %>:<%= uamport %>/logoff">
-      Logout
-    </a>
+  <div id="logInLogOut-container">
+    <a 
+      id="logInLogOut" 
+      href="http://<%= uamip %>:<%= uamport %>/logoff">Logout</a>
+    <a href="#" onClick="javascript:chilliController.refresh();">Refresh</a>
   </div>
-<% elsif [2, 5].include? result %>
-  <%= 
-    erb(
-      :_login_form,
-      :layout => false
-    )  
-  %>
-<% elsif [3, 13].include? result %>
-  <div style="text-align: center;">
-    <a href="http://<%= uamip %>:<%= uamport %>/prelogin">
-      Login
-    </a>
+<% elsif [2, 5, 3, 13].include? result %>
+  <div id="form-container">
+    <%= 
+      erb(
+        :_login_form,
+        :layout => false
+      )  
+    %>
   </div>
 <% elsif result == 11 %>
   <p>Please wait.. </p> <!-- popup1 -->
@@ -24,7 +38,53 @@
   <p>Login must be performed through ChilliSpot daemon!</p>
 <% end %>
 
-
 <% if params['reply'] %>
   <div style="text-align: center;"><%= params['reply'] %></div>
 <% end %>
+
+<% if status_window?(result) %>
+  <div id="status-container">
+    <table id="status-table">
+      <tbody>
+        <tr id="userName:row">
+          <th scope="row">Username</th>
+          <td id="userName"></td>
+        <tr id="clientState:row">
+          <th scope="row">Client State</th>
+          <td id="clientState"></td>
+        </tr>
+        <tr id="sessionTime:row">
+          <th scope="row">Session Time</th>
+          <td id="sessionTime"></td>
+        </tr>
+        <tr id="sessionTimeLeft:row">
+          <th scope="row">Session Time Left</th>
+          <td id="sessionTimeLeft"></th>
+        </tr>
+        <tr id="idleTimeout:row">
+          <th scope="row">Idle Time/Timeout</th>
+          <td id="idleTimeout"></th>
+        </tr>
+        <tr id="download:row">
+          <th scope="row">Download Traffic</th>
+          <td id="download"></td>
+        </tr>
+        <tr id="upload:row">
+          <th scope="row">Upload Traffic</th>
+          <td id="upload"></td>
+        </tr>
+        <tr id="interval:row">
+          <th scope="row" class="optinfo">Automatically updated every</th>
+          <td id="interval"></td>
+        </tr>
+      </tbody>
+    </table>
+  </div>
+
+<% end %>
+
+<% if custom_footer and File.file? custom_footer %>
+  <div id="custom-footer"><%= File.read custom_footer %></div>
+<% end %>
+
+

data/views/layout.erb

@@ -1,4 +1,6 @@
 <% 
+  require 'hotspotlogin/constants'
+
   loginpath = request.path_info
 %>
 
@@ -8,47 +10,17 @@
     <title><%= titel %></title>
     <meta http-equiv="Cache-control" content="no-cache">
     <meta http-equiv="Pragma" content="no-cache">
-    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 
-    <script language="JavaScript">
+    <script language="JavaScript"> // legacy stuff from hotspotlogin.cgi/php
+      var width = 500;  // popup
+      var height = 500; // popup
       var blur = 0;
       var starttime = new Date();
       var startclock = starttime.getTime();
       var mytimeleft = 0;
-
-      function doTime() {
-        window.setTimeout( "doTime()", 1000 );
-        t = new Date();
-        time = Math.round((t.getTime() - starttime.getTime())/1000);
-        if (mytimeleft) {
-          time = mytimeleft - time;
-          if (time <= 0) {
-            window.location = "<%= loginpath %>?res=popup3&uamip=<%= uamip %>&uamport=<%= uamport %>";
-          }
-        }
-        if (time < 0) time = 0;
-        hours = (time - (time % 3600)) / 3600;
-        time = time - (hours * 3600);
-        mins = (time - (time % 60)) / 60;
-        secs = time - (mins * 60);
-        if (hours < 10) hours = "0" + hours;
-        if (mins < 10) mins = "0" + mins;
-        if (secs < 10) secs = "0" + secs;
-        title = "Online time: " + hours + ":" + mins + ":" + secs;
-        if (mytimeleft) {
-          title = "Remaining time: " + hours + ":" + mins + ":" + secs;
-        }
-        if(document.all || document.getElementById){
-           document.title = title;
-        }
-        else {
-          self.status = title;
-        }
-      }
-
       function popUp(URL) {
         if (self.name != "chillispot_popup") {
-          chillispot_popup = window.open(URL, 'chillispot_popup', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width=500,height=375');
+          chillispot_popup = window.open(URL, 'chillispot_popup', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width=' + width + ',height=' + height);
         }
       }
 
@@ -56,21 +28,17 @@
         if (timeleft) {
           mytimeleft = timeleft;
         }
-        if ((result == 1) && (self.name == "chillispot_popup")) {
-          doTime();
-        }
         if ((result == 1) && (self.name != "chillispot_popup")) {
-          chillispot_popup = window.open(URL, 'chillispot_popup', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width=500,height=375');
+          chillispot_popup = window.open(URL, 'chillispot_popup', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width=' + width + ',height=' + height);
         }
         if ((result == 2) || result == 5) {
           document.form1.UserName.focus()
         }
         if ((result == 2) && (self.name != "chillispot_popup")) {
-          chillispot_popup = window.open('', 'chillispot_popup', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width=400,height=200');
+          chillispot_popup = window.open('', 'chillispot_popup', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width='+ width + ',height=' + height);
           chillispot_popup.close();
         }
         if ((result == 12) && (self.name == "chillispot_popup")) {
-          doTime();
           if (redirurl) {
             opener.location = redirurl;
           }
@@ -98,15 +66,35 @@
         }
       }
     </script>
+
+    <link rel="stylesheet" href="/hotspotlogin/css/default.css"/>
+    <link rel="shortcut icon" href="/hotspotlogin/favicon.ico"/>
+
   </head>
 
-  <body onLoad="javascript:doOnLoad(<%= result %>, '<%= request.path_info %>?res=popup2&uamip=<%= uamip %>&uamport=<%= uamport %>&userurl=<%= userurl %>&redirurl=<%= redirurl %>&timeleft=<%= timeleft %>','<%= userurl %>', '<%= redirurl %>', '<%= timeleft %>')" onBlur="javascript:doOnBlur($result)">
-    <div style='text-align: right; font-style: italic; margin-right: 3em; font-family: sans-serif;'>
-      hotspotlogin.rb
+  <body onLoad="javascript:doOnLoad(<%= result %>, '<%= request.path_info %>?res=popup2&uamip=<%= uamip %>&uamport=<%= uamport %>&userurl=<%= userurl %>&redirurl=<%= redirurl %>&timeleft=<%= timeleft %>','<%= userurl %>', '<%= redirurl %>', '<%= timeleft %>')" onBlur="javascript:doOnBlur(<%= result %>)">
+    <div id="powered-by">
+      Powered by <a href="http://rubygems.org/gems/hotspotlogin">hotspotlogin.rb</a>
     </div>
     <div id="main">
       <%= yield %>
     </div>
+    <% if status_window?(result) %>
+      <!-- CovaChilli JSON interface -->
+      <script 
+        type="text/javascript" src="hotspotlogin/js/ChilliLibrary.js">
+      </script>
+      <script 
+        type="text/javascript" src="hotspotlogin/js/UserStatus.js">
+      </script>
+      <script language="JavaScript">
+        showUserStatus( {
+          uamip:    "<%= uamip %>",
+          uamport:  <%= uamport %>,
+          interval: <%= interval %>
+        } );
+      </script>
+    <% end %>
   </body>
 </html>