From 31453a7e9be4fcab649cd37e43ff963eefb96290 Mon Sep 17 00:00:00 2001
From: DonatoB <donato@jwplayer.com>
Date: Fri, 6 Jun 2014 17:25:27 -0400
Subject: [PATCH] Some ideas to hopefully help out

d
exit
---
 Overview/turk/getAnswers.php  |  2 +-
 Overview/turk/moneyLeft.php   |  2 +-
 Retainer/instructions.php     |  2 ++
 Retainer/scripts/api.js       |  7 ++++++
 Retainer/scripts/setOnline.js | 45 +++++++++++++++++++++--------------
 Retainer/style/legion.css     |  4 ++--
 Retainer/style/trigger.css    |  5 ++--
 Retainer/trigger.php          |  2 +-
 baseURL.php => config.php     |  0
 index.php                     |  2 +-
 isSandbox.php                 | 17 ++++---------
 mturk.js                      | 26 +++++++++++++-------
 12 files changed, 66 insertions(+), 48 deletions(-)
 rename baseURL.php => config.php (100%)

diff --git a/Overview/turk/getAnswers.php b/Overview/turk/getAnswers.php
index 186976a..d5267cf 100755
--- a/Overview/turk/getAnswers.php
+++ b/Overview/turk/getAnswers.php
@@ -5,7 +5,7 @@
 set_time_limit ( 10000);
 
 include("../../amtKeys.php");
-include("../../baseURL.php");
+include("../../config.php");
 include("../../isSandbox.php");
 include("../../getDB.php");
 include 'turk_functions.php';
diff --git a/Overview/turk/moneyLeft.php b/Overview/turk/moneyLeft.php
index 8c36275..8cda931 100755
--- a/Overview/turk/moneyLeft.php
+++ b/Overview/turk/moneyLeft.php
@@ -2,7 +2,7 @@
 error_reporting(E_ALL);
 
 include("../../amtKeys.php");
-include("../../baseURL.php");
+include("../../config.php");
 include("../../isSandbox.php");
 include 'turk_functions.php';
 
diff --git a/Retainer/instructions.php b/Retainer/instructions.php
index f1212f3..3190572 100755
--- a/Retainer/instructions.php
+++ b/Retainer/instructions.php
@@ -1,5 +1,7 @@
 <h2 class="instructions" style="margin-left:15px"><u>Instructions</u></h2>
 <?php
+// This should be surrounded by something like
+//   if (isDebugMode()) {
 error_reporting(E_ALL);
 ini_set("display_errors", 1);
 
diff --git a/Retainer/scripts/api.js b/Retainer/scripts/api.js
index 92d699f..51e40ad 100755
--- a/Retainer/scripts/api.js
+++ b/Retainer/scripts/api.js
@@ -53,5 +53,12 @@ $(document).ready( function() {
         });
     }
 
+	// This file appears to do nothing?
+	// If these are meant to be global functions it is best to namespace them, for example
+	window.legion = {
+		call : call,
+		query_available : query_available
+	};
+
 
 });
diff --git a/Retainer/scripts/setOnline.js b/Retainer/scripts/setOnline.js
index cab15fe..5c9ee87 100755
--- a/Retainer/scripts/setOnline.js
+++ b/Retainer/scripts/setOnline.js
@@ -1,20 +1,29 @@
 $(document).ready(function() {
-setInterval( function() {
-    var worker = gup("workerId");
-    var assignment = gup("assignmentId");
-    var task = gup('task') ? gup('task') : "default";
-    //if( assignment != "ASSIGNMENT_ID_NOT_AVAILABLE" ) {
-        $.ajax({
-            url: "php/ajax_whosonline.php",
-            data: {task: task, worker: worker, role: "crowd"},
-            dataType: "text",
-            success: function(d) {
-                //
-            },
-            fail: function() {
-                alert("setOnline failed!")
-            },
-        });
-    //}
-}, 3000);
+	setInterval( function() {
+		var worker     = gup("workerId"),
+			assignment = gup("assignmentId"),
+			task       = gup('task') ? gup('task') : "default";
+
+		//if( assignment === "ASSIGNMENT_ID_NOT_AVAILABLE" ) {
+		// 		return;
+	    // }
+		$.ajax({
+			url: "php/ajax_whosonline.php",
+			dataType: "text",
+			data: {
+				task       : task,
+				worker     : worker,
+				assignment : assignment,
+				role       : "crowd"
+			},
+			success: function() { },
+			fail: function() {
+				throw {
+					name: 'counterfailed',
+					message:'something important here'
+				}
+			}
+		});
+	}, 3000);
 });
+// Wow i think i wrote this one???
diff --git a/Retainer/style/legion.css b/Retainer/style/legion.css
index acd9c83..93df6c7 100644
--- a/Retainer/style/legion.css
+++ b/Retainer/style/legion.css
@@ -34,12 +34,12 @@
 
 .legion-score-display-r {
   z-index: 100;
-  background: none !important;
+  background: none !important; // !important should be avoided as much as possible
   border: none !important;
   color: #F00 !important;
   font-weight: bold;
   overflow: hidden;
-  font-size: 1.2em;
+  font-size: 1.2em; // industry seems to prefer px lately
 }
 
 .legion-score-display-a {
diff --git a/Retainer/style/trigger.css b/Retainer/style/trigger.css
index 5f3ce7a..e53f39d 100755
--- a/Retainer/style/trigger.css
+++ b/Retainer/style/trigger.css
@@ -7,6 +7,7 @@
 	text-align: center;
 }
 
+// block stuff like this is often put into a "reset.css" file which comes before the rest of css
 body{
 	padding-left:20px;
 }
@@ -17,6 +18,4 @@ body{
     height: 21em;
 }
 
-.recruitingDiv button{
-	/*margin-bottom: 10px;*/
-}
\ No newline at end of file
+// delete unused code :)
diff --git a/Retainer/trigger.php b/Retainer/trigger.php
index 87e9a2d..1ddfac0 100755
--- a/Retainer/trigger.php
+++ b/Retainer/trigger.php
@@ -9,7 +9,7 @@
     <script type="text/javascript" src="scripts/bootstrap.touchspin.js"></script>
     <script type="text/javascript" src="scripts/hitsOverview.js"></script>
 
-    <script> var baseURL = "<?php include('../baseURL.php'); echo $baseURL; ?>"; </script>
+    <script> var baseURL = "<?php include('../config.php'); echo $baseURL; ?>"; </script>
 
     <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
     <link rel="stylesheet" href="style/trigger.css">
diff --git a/baseURL.php b/config.php
similarity index 100%
rename from baseURL.php
rename to config.php
diff --git a/index.php b/index.php
index 969cfd1..f36bedf 100755
--- a/index.php
+++ b/index.php
@@ -11,7 +11,7 @@
     <script type="text/javascript" src="Retainer/scripts/jquery.blockUI.js"></script>
     <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
 
-    <script> var baseURL = "<?php include('baseURL.php'); echo $baseURL; ?>"; </script>
+    <script> var baseURL = "<?php include('config.php'); echo $baseURL; ?>"; </script>
 
     <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
     <link rel="stylesheet" href="Retainer/style/trigger.css">
diff --git a/isSandbox.php b/isSandbox.php
index 1847866..c18b73a 100755
--- a/isSandbox.php
+++ b/isSandbox.php
@@ -1,16 +1,9 @@
 <?php
 
-
-//uncomment and comment as neccesary to determine sandbox usage
-//$SANDBOX=false;
-$SANDBOX=true;
-
-//if a URL parameter is preset, override the previous variable
-
-if(isset($_REQUEST['useSandbox']))
-{
-	if($_REQUEST['useSandbox'] == "true") $SANDBOX = true;
-	else if ($_REQUEST['useSandbox'] == "false") $SANDBOX = false;
-}
+    // I would recommend an API like this.
+    //   If &sandbox is in URL then it is sandboxed, else it is not.
+    function useSandbox() {
+        return (isset($_GET['sandbox']));
+    }
 
 ?>
diff --git a/mturk.js b/mturk.js
index f854214..239193e 100755
--- a/mturk.js
+++ b/mturk.js
@@ -14,13 +14,19 @@ var form_selector = "#mturk_form";
 
 // function for getting URL parameters
 function gup(name) {
+	// Every regex in the world needs a comment describing it!
   name = name.replace(/[\[]/,"\\\[").replace(/[\]]/,"\\\]");
-  var regexS = "[\\?&]"+name+"=([^&#]*)";
-  var regex = new RegExp(regexS);
+
+  var regexS  = "[\\?&]"+name+"=([^&#]*)";
+  var regex   = new RegExp(regexS);
   var results = regex.exec(window.location.href);
-  if(results == null)
-    return "";
-  else return unescape(results[1]);
+	// Always check for what you are looking for, instead of what it shouldn't be
+	//   this is called "whitelisting" as opposed to "blacklisting"
+  if(typeof results !== "String") {
+	  return "";
+  }
+
+  return unescape(results[1]);
 }
 
 //  Turkify the captioning page.
@@ -29,15 +35,17 @@ $(document).ready(function () {
   if((aid = gup("assignmentId"))!="" && $(form_selector).length>0) {
 
     // If the HIT hasn't been accepted yet, disabled the form fields.
-    if(aid == "ASSIGNMENT_ID_NOT_AVAILABLE") {
+	  // Always use triple equality in js
+    if(aid === "ASSIGNMENT_ID_NOT_AVAILABLE") {
 	    $('input,textarea,select').attr("DISABLED", "disabled");
     }
 
     // Add a new hidden input element with name="assignmentId" that
     // with assignmentId as its value.
-    var aid_input = $("<input type='hidden' name='assignmentId' value='" + aid + "'>").appendTo($(form_selector));
-    var workerId_input = $("<input type='hidden' name='workerId' value='" + gup("workerId") + "'>").appendTo($(form_selector));
-    var hitId_input = $("<input type='hidden' name='hitId' value='" + gup("hitId") + "'>").appendTo($(form_selector));
+	  // name jquery objects with a $ in front of name - good code convention
+    var $aid_input = $("<input type='hidden' name='assignmentId' value='" + aid + "'>").appendTo($(form_selector));
+    var $workerId_input = $("<input type='hidden' name='workerId' value='" + gup("workerId") + "'>").appendTo($(form_selector));
+    var $hitId_input = $("<input type='hidden' name='hitId' value='" + gup("hitId") + "'>").appendTo($(form_selector));
 
     // Make sure the submit form's method is POST
     $(form_selector).attr('method', 'POST');