Fixed issue #16635: Timer not working when survey is active (when exe…

…cuting the survey multiple times in the same browser/tab) (#1592)

Each timer registers itself in a local storage item identified by the Survey ID.
This is used by the reset function to know which timers belong to the survey and are to be reset.
The reset method was replaced by a function (in survey.js instead of timer.js) that reset all timers for a given survey.
Also reviewed the reset method for preview mode.

application/controllers/survey/index.php

@@ -72,6 +72,7 @@ public function action()
 
         if (isset($param['newtest']) && $param['newtest'] == "Y") {
             killSurveySession($surveyid);
+            resetQuestionTimers($surveyid);
         }
 
         $surveyExists   = ($oSurvey != null);
@@ -591,7 +592,7 @@ public function action()
 
         // Reset the question timers in preview
         if (!$isSurveyActive || $previewmode) {
-            resetQuestionTimers();
+            resetQuestionTimers($surveyid);
         }
 
         sendCacheHeaders();

application/helpers/frontend_helper.php

@@ -1953,15 +1953,16 @@ function resetTimers()
 }
 
 /**
- * Sets the 'resetQuestionTimers' flag, so timer.js can pick it and unset the localstorage
+ * Removes all question timers for this survey from local storage
  *
  * @return void
  */
-function resetQuestionTimers()
+function resetQuestionTimers($surveyid)
 {
     Yii::app()->clientScript->registerScript(
         'resetQuestionTimers',
-        'LSvar.bResetQuestionTimers=true;',
+        //'LSvar.bResetQuestionTimers=true;',
+        "resetQuestionTimers({$surveyid})",
         LSYii_ClientScript::POS_BEGIN
     );
 }

application/helpers/qanda_helper.php

@@ -486,6 +486,7 @@ function return_timer_script($aQuestionAttributes, $ia, $disable = null)
         '/survey/questions/question_timer/timer_footer',
         array(
             'iQid'=>$ia[0],
+            'iSid'=>Yii::app()->getConfig('surveyID'),
             'time_limit'=>$time_limit,
             'time_limit_action'=>$time_limit_action,
             'time_limit_warning'=>$time_limit_warning,

application/models/QuestionBaseRenderer.php

@@ -205,6 +205,7 @@ protected function getTimeSettingRender()
             '/survey/questions/question_timer/timer_footer',
             array(
                 'iQid'=>$oQuestion->qid,
+                'iSid'=>Yii::app()->getConfig('surveyID'),
                 'time_limit'=>$time_limit,
                 'time_limit_action'=>$time_limit_action,
                 'time_limit_warning'=>$time_limit_warning,

application/views/survey/questions/question_timer/timer_footer.php

@@ -15,7 +15,7 @@
  * @var $disable
  */
 Yii::app()->getClientScript()->registerScript("TimerQuestion".$iQid, "
-    countdown($iQid, $time_limit, $time_limit_action, $time_limit_warning, $time_limit_warning_2, $time_limit_warning_display_time, $time_limit_warning_2_display_time, '$disable');
+    countdown($iQid, $iSid, $time_limit, $time_limit_action, $time_limit_warning, $time_limit_warning_2, $time_limit_warning_display_time, $time_limit_warning_2_display_time, '$disable');
 ", LSYii_ClientScript::POS_POSTSCRIPT);
 ?>
 </div>

assets/packages/limesurvey/survey.js

@@ -426,3 +426,11 @@ function activateSoftMandatory(){
     });
 }
 
+function resetQuestionTimers(sid) {
+    var surveyTimersItemName = 'limesurvey_timers_by_sid_' + sid;
+    var timers = JSON.parse(window.localStorage.getItem(surveyTimersItemName) || "[]");
+    timers.forEach(function(timersessionname, idx){
+        window.localStorage.removeItem('limesurvey_timers_' + timersessionname);
+    });
+    window.localStorage.removeItem(surveyTimersItemName);
+}