/firefox.plugin/index.js - Annotate - GazeTK - Research for Cognitive Interaction

blinker / firefox.plugin / index.js @ 76dd22bd

History | View | Annotate | Download (14.764 KB)

-            a03cd52e
+/*
-dd22bd
+ * Copyright 2015 Thies Pfeiffer and Dimitri Heil and Kevin Taron
-            a03cd52e
+ * Blinker is distributed under the terms of the GNU General Public License
+ *
  * This file is part of Blinker.
+ *
  * Blinker is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
+ *
  * Blinker is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  * GNU General Public License for more details.
+ *
  * You should have received a copy of the GNU General Public License
  * along with Blinker. If not, see <http://www.gnu.org/licenses/>.
  */
-dd22bd
+            KevinTaron
 /****************************************
  * Imports
  ****************************************/
 var self = require("sdk/self");
-            a03cd52e
+var panels = require("sdk/panel");
-dd22bd
+var buttons = require('sdk/ui/button/action');
-            a03cd52e
+var tabs = require("sdk/tabs");
 var pageMod = require("sdk/page-mod");
 var pageWorker = require("sdk/page-worker");
 var settings = require("sdk/simple-prefs");
-dd22bd
+var localstore = require("sdk/simple-storage");
 var { attach, detach } = require('sdk/content/mod');
 var { Style } = require('sdk/stylesheet/style');var about_config = require("sdk/preferences/service");
-            a03cd52e
+var array = require("sdk/util/array");
 about_config.set("network.websocket.allowInsecureFromHTTPS", true);
-dd22bd
+var activeTABURL = "no";
-            a03cd52e
+var pageModWorkers = [];
 var activeWorker;
-dd22bd
+var calibrationImage = self.data.url('./images/calib.png');
 var holeImage = self.data.url('./images/hole_200.gif');
-            a03cd52e
+var currentPort = null;
 var arr;
-dd22bd
+var htmlelements = localstore.storage.htmlelements;
 if(htmlelements == null) {
   localstore.storage.htmlelements = {
     a : {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     button : {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     img : {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     audio: {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     video: {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     "input\[type=text\]": {
       "data-gaze" : "true",
       "data-gaze-type" : "text",
       "data-gaze-model" : "onscreen"
     },
     "input\[type=submit\]": {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     "input\[type=reset\]": {
       "data-gaze" : "true",
       "data-gaze-type" : "action",
       "data-gaze-model" : "onscreen"
     },
     "input\[type=email\]": {
       "data-gaze" : "true",
       "data-gaze-type" : "text",
       "data-gaze-model" : "onscreen"
     },
     "input\[type=password\]": {
       "data-gaze" : "true",
       "data-gaze-type" : "text",
       "data-gaze-model" : "onscreen"
     },
     "select": {
       "data-gaze" : "true",
       "data-gaze-type" : "choice",
       "data-gaze-model" : "onscreen"
     },
   };
   htmlelements = localstore.storage.htmlelements;
+}
 /****************************************
  * Base-Settings
  ****************************************/
 tabs.open({
     url: self.data.url("tutorial/tutorial-full.html"),
     inBackground: false,
 });
-            a03cd52e
+tabs.open({
-dd22bd
+    url: self.data.url("home/start.html"),
-            a03cd52e
+    inBackground: false,
 });
-dd22bd
+// tabs.open({
 //     url: self.data.url("performancetest/performancetest.html"),
 //     inBackground: false,
 // });
 // tabs.open({
 //     url: self.data.url("performancetest/performancetest-comment1.html"),
 //     inBackground: false,
 // });
 // tabs.open({
 //     url: self.data.url("tutorial/calibrate.html"),
 //     inBackground: false,
 // });
 /****************************************
  * Settings
  ****************************************/
-            a03cd52e
+            Thies Pfeiffer
 //initiation of the settings panel button
-dd22bd
+var button = buttons.ActionButton({
   id: "blickbrowser",
   label: "BlickBrowser Settings",
   icon: {
     "16": "./images/icons/eye-icon.png",
     "32": "./images/icons/eye-icon.png",
     "64": "./images/icons/eye-icon.png"
   },
   onClick: showSettings
 });
 /*
  *        Is called when the button's state has changed (is it checked or not)
  */
 function showSettings(state) {
     panel.port.emit('loadSettings', 'go');
     panel.show();
+}
 /*
  *        Initiate the settings panel
  */
 var panel = panels.Panel({
     contentURL: self.data.url("settings/settings.html"),
     contentScriptFile: [
       self.data.url("settings/settingsvariables.js"),
       //self.data.url("lib/jquery/jquery-3.1.1.min.js"),
       self.data.url("lib/jquery/jquery-2.2.4.min.js"),
       // self.data.url("lib/jquery/jquery-1.11.1.js"),
       self.data.url("settings/settings.js")
     ],
     position: button,
     //width: 400,
     height: 700,
 });
 /*
  * Send all blickbrowsersettings to the settings panel on request
  */
 panel.port.on('getAllSettings', function() {
     emitAllPrefs(panel.port);
     //panel.port.emit('blickBrowserSettings', settings.prefs);
 });
 /*
  *        Settings have changed from inside the settings panel - adjust them globally
  */
 panel.port.on("writeSettings", function(settings) {
     writeSettings(settings);
-            a03cd52e
+});
 /*
-dd22bd
+ *        Eyetracker calibration has been toggled from settings panel
  *        send request to eyetracker
  */
 panel.port.on("toggleCalibrate", function(value) {
     if (settings.prefs.eyeTracker == "eyetribe") {
         activeWorker.port.emit('startCalibration', 'go');
+    }
 });
 /*
  *        Calibration check is being called from settings panel - hide the panel and tell the pagemod
  */
 panel.port.on("toggleCheckCalibration", function(value) {
     if (settings.prefs.eyeTracker == "eyetribe") {
         /*tabs.activeTab.reload();*/
         panel.hide();
         //handleChange();
         activeWorker.port.emit('checkCalibration', 'go');
+    }
 });
 panel.port.on("openTutorial", function(value) {
   tabs.open({
     url: self.data.url("tutorial/tutorial-full.html"),
     inBackground: false,
   });
 });
 panel.port.on("openHTMLSettings", function(value) {
   console.log("OpenSettingsPanel");
   tabs.open({
     url: self.data.url("settings/html-gaze-attr.html"),
     inBackground: false,
   });
 });
 /*
  *        Emit blickbrowsersettings to the panel
  */
 panel.port.emit('loadSettings', 'go');
 /*
  *        Is called when the button's state has changed (is it checked or not)
  */
 function handleChange(state) {
     if (state.checked) {
         panel.port.emit('loadSettings', 'go');
         panel.show();
+    }
+}
 /*
  * update settings and send them to the active tab
  * @set: The settings array (e.g. blickBrowserSettings)
  */
 function writeSettings(set) {
     //console.log("writeSettings()");
     for (var name in set) {
         settings.prefs[name] = set [name];
+    }
     emitAllPrefs(activeWorker.port);
+}
 /*
  *        Update the panel settings button's state when settings panel is being hidden
  */
 function handleHide() {
     button.state('window', {
         checked: false
     });
+}
 /*
  * send all settings to the given port
  * @port: The port the settings are sent to (e.g. )
  */
 function emitAllPrefs(port) {
     port.emit("blickBrowserSettings", settings.prefs);
+}
 /****************************************
  * Pageworker
  ****************************************/
 /*
-            a03cd52e
+ * Initiate pageworker (WebSocketServer-Connector)
  */
 var pw = pageWorker.Page({
-dd22bd
+    contentURL: self.data.url("websocket/websocket.html")
-            a03cd52e
+});
 pw.port.on('getEyeTracker', function() {
     worker.port.emit("EyeTracker", eyeTracker);
 });
 /*
  * If pageworker
  */
 pw.port.on('getAllSettings', function() {
     emitAllPrefs(worker.port);
 });
 /*
  *        If message with name: 'eyeTrackerData' is received from pageworker, send it to the according listener
  *        inside the active pagemod
  */
 pw.port.on('eyeTrackerData', function(message) {
     //console.log("main.js :: pageMod :: port.on.eyeTrackerData" + ", message: " + message);
     if (activeWorker !== undefined) {
         switch (settings.prefs.eyeTracker) {
             case "eyetribe":
                 activeWorker.port.emit('eyeTrackerData', message);
                 break;
             case "smi":
                 activeWorker.port.emit('smiData', message);
                 break;
             case "mygaze":
                 activeWorker.port.emit('myGazeData', message);
                 break;
             default:
                 break;
+        }
+    }
 });
-dd22bd
+/****************************************
  * PageMod
  ****************************************/
-            a03cd52e
+            Thies Pfeiffer
 /*
  *        Initiate pagemod and append listeners
+ *
  */
 pageMod.PageMod({
     include: ["*", "file://*", "resource://*"],
-dd22bd
+    contentScriptFile: [
       // Basic Libs
       self.data.url("lib/jquery/jquery-2.2.4.min.js"),
       self.data.url("lib/notify.js"),
       self.data.url("lib/jquery-ui/jquery-ui.js"),
       self.data.url("lib/jquery.knob.js"),
       self.data.url("lib/jquery.nearest.js"),
       self.data.url("lib/withinViewport.js"),
       self.data.url("lib/jquery.withinViewport.js"),
       self.data.url("lib/circle-progress.js"),
       // Eyetracker Configs
       self.data.url("eyetracker/eyetribe/eyeTribe.js"),
       // Custom Scripts
       self.data.url("scripts/helpers.js"),
       self.data.url("scripts/functions.js"),
       self.data.url("scripts/types/types.js"),
       self.data.url("scripts/gazePosition.js"),
       self.data.url("scripts/emulation.js"),
       self.data.url("scripts/myscript.js"),
       // Models
       self.data.url("scripts/models/dwell.js"),
       self.data.url("scripts/models/onScreen.js"),
       self.data.url("scripts/models/piemenu.js"),
       // Modules
       self.data.url("scripts/text/keyboard.js"),
       self.data.url("scripts/text/pieKeyboard.js"),
       self.data.url("scripts/modules/piemenuOption.js"),
       self.data.url("scripts/modules/onscreenOption.js"),
       // Actions
       self.data.url("scripts/actions/actions.js"),
       self.data.url("scripts/actions/multimedia.js"),
       // Choices
       self.data.url("scripts/choices/choice.js"),
       self.data.url("scripts/choices/checkbox.js"),
       self.data.url("scripts/choices/select.js"),
       self.data.url("scripts/choices/radio.js"),
       self.data.url("scripts/choices/range.js"),
     ],
     contentStyleFile: [
       self.data.url("style/style.css"),
       self.data.url("lib/jquery-ui/jquiery-ui.css"),
       self.data.url("style/fonts/font-awesome.css"),
       // Modules
       self.data.url("style/text/keyboard.css"),
       self.data.url("style/text/piemenukeyboard.css"),
       self.data.url("style/modules/piemenu.css"),
       self.data.url("style/modules/onscreen.css"),
     ],
-            a03cd52e
+    attachTo: ["top"],
     onAttach: function(worker) {
         //set global activeworker to current pagemod
         activeWorker = worker;
-dd22bd
+        worker.port.emit("activeEmulation", true);
-            a03cd52e
+        /*
          *        if page tab / page is (re)-activated - reset the eyetribes configuration settings and refresh the
          *        blickBrowserSettings, that might have changed in another tab
          */
         worker.tab.on('activate', function() {
             activeWorker = worker;
             activeWorker.port.emit("initializeEyeTribe", "");
             emitAllPrefs(activeWorker.port);
         });
         /*
          *        if page tab / page is (re)-activated - reset the eyetribes configuration settings and refresh the
          *        blickBrowserSettings, that might have changed in another tab
          */
         worker.on('pageshow', function() {
             activeWorker = worker;
             activeWorker.port.emit("initializeEyeTribe", "");
             array.add(pageModWorkers, this);
             emitAllPrefs(activeWorker.port);
         });
         /*
          *        if page tab / page is minimized, remove the actual worker from pagemodworkers
          */
         worker.on('pagehide', function() {
             array.remove(pageModWorkers, this);
         });
         /*
          *        if page tab / page is closed, remove the actual worker from pagemodworkers
          */
         worker.on('detach', function() {
             console.log("worker detached.");
             array.remove(pageModWorkers, this);
         });
         /*
          *        ################################################################
          *        #################### PAGEMOD PORT LISTENERS ####################
          *        ################################################################
          */
         /*
          *        Redirect message from pagemod to pageworker
          */
         worker.port.on("sendToTracker", function(message) {
             pw.port.emit("toEyetracker", message);
         });
         /*
          *        Set panel button icon color
          */
         worker.port.on('setIconGreen', function() {
-dd22bd
+            button.icon = "./images/icons/eye-icon_green.png";
-            a03cd52e
+        });
         worker.port.on('setIconRed', function() {
-dd22bd
+            button.icon = "./images/icons/eye-icon_red.png";
-            a03cd52e
+        });
         worker.port.on('blickBrowserMode', function(value) {
             settings.prefs.blickBrowserMode = value;
             emitAllPrefs(activeWorker.port);
-dd22bd
+        });
         worker.port.on('openHomepage', function() {
           tabs.open({
               url: self.data.url("home/start.html"),
               inBackground: false,
           });
-            a03cd52e
+        });
         /*
          *        Settings have changed from inside the pagemod - adjust them globally
          */
         worker.port.on("writeSettings", function(settings) {
             writeSettings(settings);
         });
         /*
          *        ################################################################
          *        #################### PAGEMOD PORT EMITTERS #####################
          *        ################################################################
          */
         /*
          *        Send calibration image file to pagemod
          */
         worker.port.emit("calibrationImage", calibrationImage);
         /*
          *        Send privacy image file to pagemod
          */
         worker.port.emit("holeImage", holeImage);
+    }
 });
-dd22bd
+pageMod.PageMod({
   include: ["*", "file://*", "resource://*"],
   contentScriptFile: [
       // Basic Libs
       self.data.url("lib/jquery/jquery-2.2.4.min.js"),
       // Custom Scripts
       self.data.url("scripts/htmlElements.js"),
   ],
   onAttach: function(worker) {
     worker.port.emit("getElements", htmlelements);
+  }
-            a03cd52e
+});
-dd22bd
+pageMod.PageMod({
   include: ["resource://*"],
   contentScriptFile: [
       // Basic Libs
       self.data.url("lib/jquery/jquery-2.2.4.min.js"),
       self.data.url("lib/notify.js"),
       // Custom Scripts
       self.data.url("settings/html-gaze-attr.js"),
   ],
   onAttach: function(worker) {
     worker.port.emit("getElements", htmlelements);
     worker.port.on("setElements", function(value) {
       htmlelements = value;
       localstore.storage.htmlelements = value;
-            a03cd52e
+    });
-dd22bd
+    worker.port.on("docChange", function() {
       worker.port.emit("getElements", htmlelements);
     });
+  }
 });