testing/MCTXWeb/public_html/static/mctx.gui.js

   1 /**
   2 * MCTX3420 2013 GUI stuff.
   3 * Coding style:
   4 *  - Always end statements with semicolons
   5 *  - Egyptian brackets are highly recommended (*cough*).
   6 *  - Don't use synchronous stuff - hook events into callbacks
   7 *  - $.fn functions should return either themselves or some useful object
   8 *    to allow for chaining of method calls
   9 */
  10
  11 mctx = {};
  12 //Don't use this in the final version
  13 mctx.location = window.location.pathname;
  14 mctx.location = mctx.location.substring(0, mctx.location.lastIndexOf('/')) + "/";
  15 //mctx.location = location.protocol + "//" + location.host + "/";
  16 mctx.api = location.protocol + "//" + location.host + "/" + "api/";
  17 mctx.expected_api_version = 0;
  18 mctx.has_control = false;
  19 mctx.debug = true;
  20
  21 mctx.menu = [
  22     {'text' : 'Home', href : mctx.location + 'index.html'},
  23     {'text' : 'Experiment control', href : mctx.location + 'control.html'},
  24     {'text' : 'Pin debugging', href : mctx.location + 'pintest.html'},
  25     {'text' : 'Help', href : mctx.location + 'help.html'}
  26 ];
  27
  28 mctx.status = {
  29     OK : 1,
  30     ERROR : -1,
  31     UNAUTHORIZED : -2,
  32     NOTRUNNING : -3,
  33     ALREADYEXISTS : -4
  34 };
  35
  36 mctx.statusCodesDescription = {
  37     "1" : "Ok",
  38     "-1" : "General error",
  39     "-2" : "Unauthorized",
  40     "-3" : "Not running",
  41     "-4" : "Already exists"
  42 };
  43
  44 mctx.sensors = {
  45     0 : {name : "Strain gauge 1"},
  46     1 : {name : "Strain gauge 2"},
  47     2 : {name : "Strain gauge 3"},
  48     3 : {name : "Strain gauge 4"},
  49     4 : {name : "Pressure sensor 1"},
  50     5 : {name : "Pressure sensor 2"},
  51     6 : {name : "Pressure sensor 3"}
  52 };
  53
  54 mctx.actuators = {
  55     0 : {name : "Solenoid 1"},
  56     1 : {name : "Solenoid 2"},
  57     2 : {name : "Solenoid 3"},
  58     3 : {name : "Pressure regulator"}
  59 };
  60
  61 mctx.actuator = {};
  62 mctx.actuator.pressure_regulator = 0;
  63
  64 mctx.strain_gauges = {};
  65 mctx.strain_gauges.ids = [0, 1, 2, 3];
  66 mctx.strain_gauges.time_limit = 20;
  67
  68 /**
  69 * Logs a message if mctx.debug is enabled. This function takes
  70 * a variable number of arguments and passes them
  71 * to alert or console.log (based on browser support).
  72 * @returns {undefined}
  73 */
  74 function debugLog () {
  75     if (mctx.debug) {
  76         if (typeof console === "undefined" || typeof console.log === "undefined") {
  77             for (var i = 0; i < arguments.length; i++) {
  78                 alert(arguments[i]);
  79             }
  80         } else {
  81             try {
  82               console.log.apply(this, arguments);
  83             } catch (e) {
  84               //Chromie
  85               for (var i = 0; i < arguments.length; i++) {
  86                 console.log(arguments[i]);
  87               }
  88             }
  89         }
  90     }
  91 }
  92
  93 /**
  94 * Writes the current date to wherever it's called.
  95 */
  96 function getDate() {
  97     document.write((new Date()).toDateString());
  98 }
  99
 100 /**
 101 * Should be run before the load of any GUI page.
 102 * To hook events to be called after this function runs,
 103 * use the 'always' method, e.g runBeforeLoad().always(function() {my stuff});
 104 * @param {type} isLoginPage
 105 * @returns The return value of calling $.ajax
 106 */
 107 function runBeforeLoad(isLoginPage) {
 108     return $.ajax({
 109         url : mctx.api + "identify"
 110     }).done(function (data) {
 111         if (data.logged_in && isLoginPage) {
 112             if (mctx.debug) {
 113                 debugLog("Redirect disabled!");
 114             } else {
 115                 window.location = mctx.location;
 116             }
 117         } else if (!data.logged_in && !isLoginPage) {
 118             if (mctx.debug) {
 119                 debugLog("Redirect disabled!");
 120             } else {
 121                 //Note: this only clears the nameless cookie
 122                 document.cookie = "";
 123                 window.location = mctx.location + "login.html";
 124             }
 125         } else {
 126             mctx.friendlyName = data.user_name;
 127         }
 128
 129         $(document).ready(function () {
 130           //Show the content!
 131           $("#content").css("display", "block");
 132
 133           //Set the welcome bar
 134           var name = " " + (mctx.friendlyName ? mctx.friendlyName : "");
 135           $("#welcome-container").text("Welcome"+ name + "!");
 136           $("#logout-container").css("display", "block");
 137           //$("#menu-container").populateNavbar();
 138
 139           $("#logout").click(function () {
 140             $("#logout").logout();
 141           });
 142
 143           //Enable the error log, if present
 144           $("#errorlog").setErrorLog();
 145         });
 146     }).fail(function (jqHXR) {
 147         if (mctx.debug) {
 148             debugLog("Failed to ident server. Is API running?")
 149         } else if (!isLoginPage) {
 150             window.location = mctx.location + "login.html";
 151         }
 152     }).always(function () {
 153
 154     });
 155 }
 156
 157 /**
 158  * Populates the navigation menu.
 159  */
 160 $.fn.populateNavMenu = function() {
 161     var root = $("<ul/>")
 162     for (var i = 0; i < mctx.menu.length; i++) {
 163         var item = mctx.menu[i];
 164         var entry = $("<li/>").append(
 165             $("<a/>", {text : item.text, href: item.href})
 166         );
 167         root.append(entry);
 168     }
 169     $(this).append(root);
 170     return this;
 171 }
 172
 173 /**
 174 * Performs a login attempt.
 175 * @returns The AJAX object of the login request */
 176 $.fn.login = function () {
 177     var username = this.find("input[name='username']").val();
 178     var password = this.find("input[name='pass']").val();
 179     var out = this.find("#result");
 180     var redirect = function () {
 181         window.location.href = mctx.location;
 182     };
 183
 184     out.removeAttr("class");
 185     out.text("Logging in...");
 186
 187     return $.ajax({
 188         url : mctx.api + "bind",
 189         data : {user: username, pass : password}
 190     }).done(function (data) {
 191         if (data.status < 0) {
 192             mctx.has_control = false;
 193             out.attr("class", "fail");
 194             out.text("Login failed: " + data.description);
 195         } else {
 196             //todo: error check
 197             mctx.has_control = true;
 198             out.attr("class", "pass");
 199             out.text("Login ok!");
 200             setTimeout(redirect, 800);
 201         }
 202     }).fail(function (jqXHR) {
 203         mctx.has_control = false;
 204         out.attr("class", "fail");
 205         out.text("Login request failed - connection issues.")
 206     });
 207 };
 208
 209 /**
 210 * Performs a logout request. The nameless cookie is
 211 * always cleared and the browser redirected to the login page,
 212 * independent of whether or not logout succeeded.
 213 * @returns  The AJAX object of the logout request.
 214 */
 215 $.fn.logout = function () {
 216     return $.ajax({
 217         url : mctx.api + "unbind"
 218     }).always(function () {
 219         //Note: this only clears the nameless cookie
 220         document.cookie = "";
 221         window.location = mctx.location + "login.html";
 222     });
 223 };
 224
 225 /**
 226 * Sets the error log to continuously update.
 227 * @returns itself */
 228 $.fn.setErrorLog = function () {
 229     var url = mctx.api + "errorlog";
 230     var outdiv = this;
 231
 232     if ($(this).length <= 0) {
 233       //No error log, so do nothing.
 234       return;
 235     }
 236
 237     var updater = function () {
 238         $.ajax({url : url}).done(function (data) {
 239             outdiv.text(data);
 240             outdiv.scrollTop(
 241               outdiv[0].scrollHeight - outdiv.height()
 242             );
 243             setTimeout(updater, 3000);
 244         }).fail(function (jqXHR) {
 245             if (jqXHR.status === 502 || jqXHR.status === 0) {
 246                 outdiv.text("Failed to retrieve the error log.");
 247             }
 248             setTimeout(updater, 10000); //poll at slower rate
 249         });
 250     };
 251
 252     updater();
 253     return this;
 254 };
 255
 256 $.fn.checkStatus = function(data) {
 257   if (data.status !== mctx.status.OK) {
 258     $(this).text(data.description).removeClass("pass").addClass("fail");
 259     return false;
 260   }
 261   $(this).removeClass("fail");
 262   return true;
 263 };
 264
 265 $(document).ready(function () {
 266   //Enable the hide/show clicks
 267   $("#sidebar-hide").click(function () {
 268     $("#sidebar").hide();
 269     $("#sidebar-show").show();
 270     return this;
 271   });
 272
 273   $("#sidebar-show").click(function () {
 274     $("#sidebar-show").hide();
 275     $("#sidebar").show();
 276     return this;
 277   });
 278 });
 279
 280 $(document).ajaxError(function (event, jqXHR) {
 281     //console.log("AJAX query failed with: " + jqXHR.status + " (" + jqXHR.statusText + ")");
 282 });