/
SurveyRuntimeHelper.php
1750 lines (1454 loc) · 82.6 KB
/
SurveyRuntimeHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/*
* LimeSurvey
* Copyright (C) 2007-2011 The LimeSurvey Project Team / Carsten Schmitz
* All rights reserved.
* License: GNU/GPL License v2 or later, see LICENSE.php
* LimeSurvey is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*
*/
class SurveyRuntimeHelper {
/**
* In the 2.x version of LimeSurvey and priors, the main run method was using a variable called redata fed via get_defined_vars. It was making hard to move piece of code to subfuntions.
* Those private variables are just a step to make easier refactorisation of this file, to have a global overview about what is set in this helper, and to move easely piece of code to new methods:
* The methods get/set the private variables, and defore calling get_defined_vars, variables are created from those private variables.
* It's just a first step. get_defined_vars should be removed, and most of the private variables here should be moved to the correct object:
* i.e: all the private variable concerning the survey should be moved to the survey model and replaced by a $oSurvey
*/
// parameters
private $param;
// Preview datas
private $previewquestion = false;
private $previewgrp = false;
private $preview = false;
// Template datas
private $oTemplate; // Template configuration object (set in model TemplateConfiguration)
private $sTemplateViewPath; // Path of the layout files in template
// LEM Datas
private $LEMsessid;
private $LEMdebugLevel = 0; // customizable debugging for Lime Expression Manager ; LEM_DEBUG_TIMING; (LEM_DEBUG_TIMING + LEM_DEBUG_VALIDATION_SUMMARY + LEM_DEBUG_VALIDATION_DETAIL);
private $LEMskipReprocessing = false; // true if used GetLastMoveResult to avoid generation of unneeded extra JavaScript
// Survey settings:
// TODO: To respect object oriented design, all those "states" should be move to SurveyDynamic model, or its related models via relations.
// The only private variable here should be $oSurvey.
private $aSurveyInfo; // Array returned by common_helper::getSurveyInfo(); (survey row + language settings );
private $iSurveyid = null; // The survey id
private $bShowEmptyGroup = false; // True only when $_SESSION[$this->LEMsessid]['step'] == 0 ; Just a variable for a logic step ==> should not be a Class variable (for now, only here for the redata== get_defined_vars mess)
private $sSurveyMode; // {Group By Group, All in one, Question by question}
private $aSurveyOptions; // Few options comming from thissurvey, App->getConfig, LEM. Could be replaced by $oSurvey + relations ; the one coming from LEM and getConfig should be public variable on the surveyModel, set via public methods (active, allowsave, anonymized, assessments, datestamp, deletenonvalues, ipaddr, radix, refurl, savetimings, surveyls_dateformat, startlanguage, target, tempdir,timeadjust)
private $sLangCode; // Current language code
// moves
private $aMoveResult = false; // Contains the result of LimeExpressionManager::JumpTo() OR LimeExpressionManager::NavigateBackwards() OR NavigateForwards::LimeExpressionManager(). TODO: create a function LimeExpressionManager::MoveTo that call the right method
private $move = null; // The move requested by user. Set by frontend_helper::getMove() from the POST request.
private $bInvalidLastPage = false; // Just a variable used to check if user submitted a survey while it's not finished. Just a variable for a logic step ==> should not be a Class variable (for now, only here for the redata== get_defined_vars mess)
private $aStepInfo;
// Popups: HTML of popus. If they are null, no popup. If they contains a string, a popup will be shown to participant.
// They could probably be merged.
private $backpopup = false; // "Please use the LimeSurvey navigation buttons or index. It appears you attempted to use the browser back button to re-submit a page."
private $popup = false; // savedcontrol, mandatory_popup
private $notvalidated; // question validation error
// response
// TODO: To respect object oriented design, all those "states" should be move to Response model, or its related models via relations.
private $notanswered; // A global variable...Should be $oResponse->notanswered
private $filenotvalidated = false; // Same, but specific to file question type. (seems to be problematic by the past)
// strings
private $completed; // The string containing the completed message
// Boolean helpers
private $okToShowErrors; // true if we must show error in page : it's a submited ($_POST) page and show the same page again for some reason
// Group
private $gid;
private $groupname;
private $groupdescription;
/**
* Main function
*
* @param mixed $surveyid
* @param mixed $args
*/
public function run($surveyid,$args)
{
// Survey settings
$this->setSurveySettings( $surveyid, $args);
// Start rendering
$this->makeLanguageChanger(); // language changer can be used on any entry screen, so it must be set first
extract($args);
///////////////////////////////////////////////////////////
// 1: We check if token and/or captcha form shouls be shown
if (!isset($_SESSION[$this->LEMsessid]['step'])){
$this->showTokenOrCaptchaFormsIfNeeded();
}
if ( !$this->previewgrp && !$this->previewquestion){
$this->initMove(); // main methods to init session, LEM, moves, errors, etc
$this->checkQuotas(); // check quotas (then the process will stop here)
$this->displayFirstPageIfNeeded();
$this->saveAllIfNeeded();
$this->saveSubmitIfNeeded();
// TODO: move somewhere else
$this->setNotAnsweredAndNotValidated();
}else{
$this->setPreview();
}
$this->moveSubmitIfNeeded();
$this->setGroup();
$this->fixMaxStep();
//******************************************************************************************************
//PRESENT SURVEY
//******************************************************************************************************
$this->okToShowErrors = $okToShowErrors = (!($this->previewgrp || $this->previewquestion) && ($this->bInvalidLastPage || $_SESSION[$this->LEMsessid]['prevstep'] == $_SESSION[$this->LEMsessid]['step']));
Yii::app()->getController()->loadHelper('qanda');
setNoAnswerMode($this->aSurveyInfo);
//Iterate through the questions about to be displayed:
$inputnames = array();
$vpopup = $fpopup = false;
$upload_file = null;
foreach ($_SESSION[$this->LEMsessid]['grouplist'] as $gl){
$gid = $gl['gid'];
$qnumber = 0;
if ($this->sSurveyMode != 'survey'){
$onlyThisGID = $this->aStepInfo['gid'];
if ($onlyThisGID != $gid){
continue;
}
}
//// To diplay one question, all the questions are processed ?
$qanda = array();
$upload_file = false;
foreach ($_SESSION[$this->LEMsessid]['fieldarray'] as $key => $ia){
++$qnumber;
$ia[9] = $qnumber; // incremental question count;
// Make $qanda only for needed question $ia[10] is the randomGroup and $ia[5] the real group
if ((isset($ia[10]) && $ia[10] == $gid) || (!isset($ia[10]) && $ia[5] == $gid)){
if ($this->sSurveyMode == 'question' && $ia[0] != $this->aStepInfo['qid']){
continue;
}
$qidattributes = QuestionAttribute::model()->getQuestionAttributes($ia[0]);
if ($ia[4] != '*' && ($qidattributes === false || !isset($qidattributes['hidden']) || $qidattributes['hidden'] == 1)){
continue;
}
//Get the answers/inputnames
// TMSW - can content of retrieveAnswers() be provided by LEM? Review scope of what it provides.
// TODO - retrieveAnswers is slow - queries database separately for each question. May be fixed in _CI or _YII ports, so ignore for now
list($plus_qanda, $plus_inputnames) = retrieveAnswers($ia);
if ($plus_qanda){
$plus_qanda[] = $ia[4];
$plus_qanda[] = $ia[6]; // adds madatory identifyer for adding mandatory class to question wrapping div
// Add a finalgroup in qa array , needed for random attribute : TODO: find a way to have it in new quanda_helper in 2.1
if(isset($ia[10]))
$plus_qanda['finalgroup']=$ia[10];
else
$plus_qanda['finalgroup']=$ia[5];
$qanda[] = $plus_qanda;
}
if ($plus_inputnames){
$inputnames = addtoarray_single($inputnames, $plus_inputnames);
}
//Display the "mandatory" popup if necessary
// TMSW - get question-level error messages - don't call **_popup() directly
if ($okToShowErrors && $this->aStepInfo['mandViolation']){
list($mandatorypopup, $this->popup) = mandatory_popup($ia, $this->notanswered);
}
//Display the "validation" popup if necessary
if ($okToShowErrors && !$this->aStepInfo['valid']){
list($validationpopup, $vpopup) = validation_popup($ia, $this->notvalidated);
}
// Display the "file validation" popup if necessary
if ($okToShowErrors && ($this->filenotvalidated !== false) ){
list($filevalidationpopup, $fpopup) = file_validation_popup($ia, $this->filenotvalidated);
}
}
if ($ia[4] == "|")
$upload_file = true;
} //end iteration
}
if ($this->sSurveyMode != 'survey' && isset($this->aSurveyInfo['showprogress']) && $this->aSurveyInfo['showprogress'] == 'Y'){
if ($this->bShowEmptyGroup){
$this->aSurveyInfo['progress']['currentstep'] = $_SESSION[$this->LEMsessid]['totalsteps'] + 1;
$this->aSurveyInfo['progress']['total'] = $_SESSION[$this->LEMsessid]['totalsteps'];
}else{
$this->aSurveyInfo['progress']['currentstep'] = $_SESSION[$this->LEMsessid]['step'];
$this->aSurveyInfo['progress']['total'] = $_SESSION[$this->LEMsessid]['totalsteps'];
}
}
$this->aSurveyInfo['yiiflashmessages'] = Yii::app()->user->getFlashes();
/**
* create question index only in SurveyRuntime, not needed elsewhere, add it to GlobalVar : must be always set even if empty
*
*/
$this->aSurveyInfo['aQuestionIndex']['bShow'] = false;
if ($this->aSurveyInfo['questionindex']){
if(!$this->previewquestion && !$this->previewgrp){
$this->aSurveyInfo['aQuestionIndex']['items'] = ls\helpers\questionIndexHelper::getInstance()->getIndexItems();
if($this->aSurveyInfo['questionindex'] > 1){
$this->aSurveyInfo['aQuestionIndex']['type'] = 'full';
}else{
$this->aSurveyInfo['aQuestionIndex']['type'] = 'incremental';
}
}
if ( count($this->aSurveyInfo['aQuestionIndex']['items']) > 0){
$this->aSurveyInfo['aQuestionIndex']['bShow'] = true;
}
}
sendCacheHeaders();
Yii::app()->loadHelper('surveytranslator');
$this->aSurveyInfo['upload_file'] = $upload_file;
$hiddenfieldnames = $this->aSurveyInfo['hiddenfieldnames'] = implode("|", $inputnames);
Yii::app()->clientScript->registerScriptFile(Yii::app()->getConfig("generalscripts").'nojs.js',CClientScript::POS_HEAD);
// Show question code/number
$this->aSurveyInfo['aShow'] = $this->getShowNumAndCode();
$aPopup=array(); // We can move this part where we want now
if ( $this->backpopup != false ){
$aPopup[]=$this->backpopup;// If user click reload: no need other popup
}else{
if ( $this->popup != false ){
$aPopup[] = $this->popup;
}
if ( $vpopup != false ){
$aPopup[]=$vpopup;
}
if ( $fpopup != false ){
$aPopup[]=$fpopup;
}
}
$this->aSurveyInfo['jPopup'] = json_encode($aPopup);
$bShowpopups = Yii::app()->getConfig('showpopups');
$aErrorHtmlMessage = $this->getErrorHtmlMessage();
$this->aSurveyInfo['errorHtml']['show'] = !empty($aErrorHtmlMessage);
$this->aSurveyInfo['errorHtml']['hiddenClass'] = $bShowpopups ? "ls-js-hidden ":"";
$this->aSurveyInfo['errorHtml']['messages'] = $aErrorHtmlMessage;
$_gseq = -1;
foreach ($_SESSION[$this->LEMsessid]['grouplist'] as $gl){
++$_gseq;
$gid = $gl['gid'];
$aGroup = array();
$groupname = $gl['group_name'];
$groupdescription = $gl['description'];
if ($this->sSurveyMode != 'survey' && $gid != $onlyThisGID){
continue;
}
Yii::app()->setConfig('gid',$gid);// To be used in templaterplace in whole group. Attention : it's the actual GID (not the GID of the question)
$aGroup['class'] = "";
$gnoshow = LimeExpressionManager::GroupIsIrrelevantOrHidden($_gseq);
$redata = compact(array_keys(get_defined_vars()));
if ($gnoshow && !$this->previewgrp){
$aGroup['class'] = ' ls-hidden';
}
$aGroup['name'] = $gl['group_name'];
$aGroup['gseq'] = $_gseq;
$showgroupinfo_global_ = getGlobalSetting('showgroupinfo');
$aSurveyinfo = getSurveyInfo($this->iSurveyid);
// Look up if there is a global Setting to hide/show the Questiongroup => In that case Globals will override Local Settings
if(($aSurveyinfo['showgroupinfo'] == $showgroupinfo_global_) || ($showgroupinfo_global_ == 'choose')){
$showgroupinfo_ = $aSurveyinfo['showgroupinfo'];
} else {
$showgroupinfo_ = $showgroupinfo_global_;
}
$showgroupdesc_ = $showgroupinfo_ == 'B' /* both */ || $showgroupinfo_ == 'D'; /* (group-) description */
$aGroup['showdescription'] = (!$this->previewquestion && trim($redata['groupdescription'])!="" && $showgroupdesc_);
$aGroup['description'] = $redata['groupdescription'];
// one entry per QID
foreach ($qanda as $qa) {
$qid = $qa[4];
$qinfo = LimeExpressionManager::GetQuestionStatus($qid);
$lemQuestionInfo = LimeExpressionManager::GetQuestionStatus($qid);
$lastgrouparray = explode("X", $qa[7]);
$lastgroup = $lastgrouparray[0] . "X" . $lastgrouparray[1]; // id of the last group, derived from question id
$lastanswer = $qa[7];
if ($qinfo['hidden'] && $qinfo['info']['type'] != '*'){
continue; // skip this one
}
$question = $qa[0];
//===================================================================
// The following four variables offer the templating system the
// capacity to fully control the HTML output for questions making the
// above echo redundant if desired.
$question['sgq'] = $qa[7];
$question['aid'] = !empty($qinfo['info']['aid']) ? $qinfo['info']['aid'] : 0;
$question['sqid'] = !empty($qinfo['info']['sqid']) ? $qinfo['info']['sqid'] : 0;
//===================================================================
// easier to understand for survey maker
$aGroup['aQuestions'][$qid]['qid'] = $qa[4];
$aGroup['aQuestions'][$qid]['code'] = $qa[5];
$aGroup['aQuestions'][$qid]['number'] = $qa[0]['number'];
$aGroup['aQuestions'][$qid]['text'] = LimeExpressionManager::ProcessString($qa[0]['text'], $qa[4], NULL, false, 3, 1, false, true, false);
$aGroup['aQuestions'][$qid]['SGQ'] = $qa[7];
$aGroup['aQuestions'][$qid]['mandatory'] = $qa[0]['mandatory'];
$aGroup['aQuestions'][$qid]['input_error_class'] = $qa[0]['input_error_class'];
$aGroup['aQuestions'][$qid]['valid_message'] = $qa[0]['valid_message'];
$aGroup['aQuestions'][$qid]['file_valid_message'] = $qa[0]['file_valid_message'];
$aGroup['aQuestions'][$qid]['man_message'] = $qa[0]['man_message'];
$aGroup['aQuestions'][$qid]['answer'] = $qa[1];
$aGroup['aQuestions'][$qid]['help']['show'] = (flattenText( $lemQuestionInfo['info']['help'], true,true) != '');
$aGroup['aQuestions'][$qid]['help']['text'] = LimeExpressionManager::ProcessString($lemQuestionInfo['info']['help'], $qa[4], NULL, false, 3, 1, false, true, false);
}
$aGroup['show_last_group'] = $aGroup['show_last_answer'] = false;
$aGroup['lastgroup'] = $aGroup['lastanswer'] = '';
if (!empty($qanda)){
if ($this->sSurveyMode == 'group') {
$aGroup['show_last_group'] = true;
$aGroup['lastgroup'] = $lastgroup;
}
if ($this->sSurveyMode == 'question') {
$aGroup['show_last_answer'] = true;
$aGroup['lastanswer'] = $lastanswer;
}
}
Yii::app()->setConfig('gid','');
$this->aSurveyInfo['aGroups'][$gid] = $aGroup;
}
LimeExpressionManager::FinishProcessingGroup($this->LEMskipReprocessing);
$this->aSurveyInfo['EM']['ScriptsAndHiddenInputs'] = LimeExpressionManager::GetRelevanceAndTailoringJavaScript();
Yii::app()->clientScript->registerScript('triggerEmRelevance',"triggerEmRelevance();",CClientScript::POS_END);
/* Maybe only if we have mandatory error ?*/
Yii::app()->clientScript->registerScript('updateMandatoryErrorClass',"updateMandatoryErrorClass();",CClientScript::POS_END);
LimeExpressionManager::FinishProcessingPage();
/**
* Navigator
*/
$this->aSurveyInfo['aNavigator'] = array();
$this->aSurveyInfo['aNavigator']['show'] = $aNavigator['show'] = $this->aSurveyInfo['aNavigator']['save']['show'] = $this->aSurveyInfo['aNavigator']['load']['show'] = false;
if (!$this->previewgrp && !$this->previewquestion){
$this->aSurveyInfo['aNavigator'] = getNavigatorDatas();
$this->aSurveyInfo['hiddenInputs'] = "<input type='hidden' name='thisstep' value='{$_SESSION[$this->LEMsessid]['step']}' id='thisstep' />\n";
$this->aSurveyInfo['hiddenInputs'] .= "<input type='hidden' name='sid' value='$this->iSurveyid' id='sid' />\n";
$this->aSurveyInfo['hiddenInputs'] .= "<input type='hidden' name='start_time' value='" . time() . "' id='start_time' />\n";
$_SESSION[$this->LEMsessid]['LEMpostKey'] = mt_rand();
$this->aSurveyInfo['hiddenInputs'] .= "<input type='hidden' name='LEMpostKey' value='{$_SESSION[$this->LEMsessid]['LEMpostKey']}' id='LEMpostKey' />\n";
global $token;
if ($token){
$this->aSurveyInfo['hiddenInputs'] .= "\n<input type='hidden' name='token' value='$token' id='token' />\n";
}
}
// For "clear all" buttons
$this->aSurveyInfo['jYesNo'] = ls_json_encode(array('yes'=>gT("Yes"),'no'=>gT("No")));
$this->aSurveyInfo['aLEM']['debugtimming']['show'] = false;
if (($this->LEMdebugLevel & LEM_DEBUG_TIMING) == LEM_DEBUG_TIMING){
$this->aSurveyInfo['aLEM']['debugtimming']['show'] = true;
$this->aSurveyInfo['aLEM']['debugtimming']['script'] = LimeExpressionManager::GetDebugTimingMessage();
}
$this->aSurveyInfo['aLEM']['debugvalidation']['show'] = false;
if (($this->LEMdebugLevel & LEM_DEBUG_VALIDATION_SUMMARY) == LEM_DEBUG_VALIDATION_SUMMARY){
$this->aSurveyInfo['aLEM']['debugvalidation']['show'] = true;
$this->aSurveyInfo['aLEM']['debugvalidation']['message'] = $this->aMoveResult['message'];
}
Yii::app()->twigRenderer->renderTemplateFromFile("layout_main.twig", array('oSurvey'=> Survey::model()->findByPk($this->iSurveyid), 'aSurveyInfo'=>$this->aSurveyInfo), false);
}
public function getShowNumAndCode()
{
$showqnumcode_global_ = getGlobalSetting('showqnumcode');
$showqnumcode_survey_ = $this->aSurveyInfo['showqnumcode'];
// Check global setting to see if survey level setting should be applied
if($showqnumcode_global_ == 'choose') { // Use survey level settings
$showqnumcode_ = $showqnumcode_survey_; //B, N, C, or X
} else {
// Use global setting
$showqnumcode_ = $showqnumcode_global_; //both, number, code, or none
}
switch ($showqnumcode_){
// Both
case 'both':
case 'B':
$aShow['question_code'] = true;
$aShow['question_number'] = true;
break;
// Number only
case 'number':
case 'N':
$aShow['question_code'] = false;
$aShow['question_number'] = true;
break;
// Code only
case 'code':
case 'C':
$aShow['question_code'] = true;
$aShow['question_number'] = false;
break;
// Neither
case 'none':
case 'X':
default:
$aShow['question_code'] = false;
$aShow['question_number'] = false;
break;
}
return $aShow;
}
/**
* Init session/params values depending of user moves
*
* - It init the needed variables for navigation: initFirstStep, initTotalAndMaxSteps, setMoveResult
* - Then perform all the needed checks before moving:
* + did the participant used browser navigation?
* + did he pressed clear cancel, is he a confirmed quota?
* + Is the previous step set?
* + Is the survey finished?
* + Are all the answer validated? (like: participant didn't answered to a mandatory question)
*/
private function initMove()
{
$this->initFirstStep(); // If it's the first time user load this survey, will init session and LEM
$this->initTotalAndMaxSteps();
$this->checkIfUseBrowserNav(); // Check if user used browser navigation, or relaoded page
if ($this->move != 'clearcancel' && $this->move != 'confirmquota'){
$this->checkPrevStep(); // Check if prev step is set, else set it
$this->setMoveResult();
$this->checkClearCancel();
$this->setPrevStep();
$this->checkIfFinished();
$this->setStep();
// CHECK UPLOADED FILES
// TMSW - Move this into LEM::NavigateForwards?
$this->filenotvalidated = checkUploadedFileValidity($this->iSurveyid, $this->move);
//SEE IF THIS GROUP SHOULD DISPLAY
if ($_SESSION[$this->LEMsessid]['step'] == 0) {
$this->bShowEmptyGroup = true;
}
// For welcome screen
$this->thissurvey['iTotalquestions'] = $_SESSION['survey_'.$this->iSurveyid]['totalquestions'];
$showxquestions = Yii::app()->getConfig('showxquestions');
$this->thissurvey['bShowxquestions'] = ( $showxquestions == 'show' || ($showxquestions == 'choose' && !isset($this->aSurveyInfo['showxquestions'])) || ($showxquestions == 'choose' && $this->aSurveyInfo['showxquestions'] == 'Y'));
}
}
/**
* Now it's ok ^^
*/
private function setArgs()
{
if ($this->sMove == "movesubmit"){
if ($this->aSurveyInfo['refurl'] == "Y"){
//Only add this if it doesn't already exist
if (!in_array("refurl", $_SESSION[$this->LEMsessid]['insertarray'])){
$_SESSION[$this->LEMsessid]['insertarray'][] = "refurl";
}
}
resetTimers();
//Before doing the "templatereplace()" function, check the $this->aSurveyInfo['url']
//field for limereplace stuff, and do transformations!
$this->aSurveyInfo['surveyls_url'] = passthruReplace($this->aSurveyInfo['surveyls_url'], $this->aSurveyInfo);
$this->aSurveyInfo['surveyls_url'] = templatereplace($this->aSurveyInfo['surveyls_url'], array(), $redata, 'URLReplace', false, NULL, array(), true ); // to do INSERTANS substitutions
//THE FOLLOWING DEALS WITH SUBMITTING ANSWERS AND COMPLETING AN ACTIVE SURVEY
//don't use cookies if tokens are being used
if (!empty($this->aSurveyInfo['active']) && $this->aSurveyInfo['active'] == "Y"){
global $tokensexist;
if ($this->aSurveyInfo['usecookie'] == "Y" && $tokensexist != 1) {
setcookie("LS_" . $this->iSurveyid . "_STATUS", "COMPLETE", time() + 31536000); //Cookie will expire in 365 days
}
}
}
}
/**
* Retreive the survey format (mode?)
* TODO: move to survey model
*
* @return string
*/
private function setSurveyMode()
{
switch ($this->aSurveyInfo['format'])
{
case "A": //All in one
$this->sSurveyMode = 'survey';
break;
default:
case "S": //One at a time
$this->sSurveyMode = 'question';
break;
case "G": //Group at a time
$this->sSurveyMode = 'group';
break;
}
}
/**
* Retreive the radix
* @return string
*/
private function getRadix()
{
$radix = getRadixPointData($this->aSurveyInfo['surveyls_numberformat']);
$radix = $radix['separator'];
return $radix;
}
/**
* Retreives dew options comming from thissurvey, App->getConfig, LEM.
* TODO: move to survey model
*
*/
private function setSurveyOptions()
{
global $clienttoken;
$radix = $this->getRadix();
$timeadjust = Yii::app()->getConfig("timeadjust");
$this->aSurveyOptions = array(
'active' => ($this->aSurveyInfo['active'] == 'Y'),
'allowsave' => ($this->aSurveyInfo['allowsave'] == 'Y'),
'anonymized' => ($this->aSurveyInfo['anonymized'] != 'N'),
'assessments' => ($this->aSurveyInfo['assessments'] == 'Y'),
'datestamp' => ($this->aSurveyInfo['datestamp'] == 'Y'),
'deletenonvalues' => Yii::app()->getConfig('deletenonvalues'),
'hyperlinkSyntaxHighlighting' => (($this->LEMdebugLevel & LEM_DEBUG_VALIDATION_SUMMARY) == LEM_DEBUG_VALIDATION_SUMMARY), // TODO set this to true if in admin mode but not if running a survey
'ipaddr' => ($this->aSurveyInfo['ipaddr'] == 'Y'),
'radix' => $radix,
'refurl' => (($this->aSurveyInfo['refurl'] == "Y" && isset($_SESSION[$this->LEMsessid]['refurl'])) ? $_SESSION[$this->LEMsessid]['refurl'] : NULL),
'savetimings' => ($this->aSurveyInfo['savetimings'] == "Y"),
'surveyls_dateformat' => ( ($timeadjust!=0) ? $this->aSurveyInfo['surveyls_dateformat'] : 1),
'startlanguage' => (isset(App()->language) ? App()->language : $this->aSurveyInfo['language']),
'target' => Yii::app()->getConfig('uploaddir').DIRECTORY_SEPARATOR.'surveys'.DIRECTORY_SEPARATOR.$this->aSurveyInfo['sid'].DIRECTORY_SEPARATOR.'files'.DIRECTORY_SEPARATOR,
'tempdir' => Yii::app()->getConfig('tempdir').DIRECTORY_SEPARATOR,
'timeadjust' => $timeadjust,
'token' => $clienttoken,
);
}
/**
* If it's the first time the survey is loaded:
* - Init session, randomization and filed array
* - Check surveyid coherence
* - Init $LEM states.
* - Decide if Welcome page should be shown
*/
private function initFirstStep()
{
// First time the survey is loaded
if (!isset($_SESSION[$this->LEMsessid]['step']))
{
// Init session, randomization and filed array
buildsurveysession($this->iSurveyid);
randomizationGroupsAndQuestions($this->iSurveyid);
// Check surveyid coherence
if($this->iSurveyid != LimeExpressionManager::getLEMsurveyId())
LimeExpressionManager::SetDirtyFlag();
// Init $LEM states.
LimeExpressionManager::StartSurvey($this->iSurveyid, $this->sSurveyMode, $this->aSurveyOptions, false, $this->LEMdebugLevel);
$_SESSION[$this->LEMsessid]['step'] = 0;
// Welcome page.
if ($this->sSurveyMode == 'survey'){
LimeExpressionManager::JumpTo(1, false, false, true);
}elseif (isset($this->aSurveyInfo['showwelcome']) && $this->aSurveyInfo['showwelcome'] == 'N'){
$this->aMoveResult = LimeExpressionManager::NavigateForwards();
$_SESSION[$this->LEMsessid]['step'] = 1;
}
}elseif($this->iSurveyid != LimeExpressionManager::getLEMsurveyId()){
$this->initDirtyStep();
}
}
/**
* If a step is requested, but the survey id in the session is different from the requested one
* It reload the needed infos for the requested survey and jump to the requested step.
*/
private function initDirtyStep()
{
//$_SESSION[$this->LEMsessid]['step'] can not be less than 0, fix it always #09772
$_SESSION[$this->LEMsessid]['step'] = $_SESSION[$this->LEMsessid]['step']<0 ? 0 : $_SESSION[$this->LEMsessid]['step'];
LimeExpressionManager::StartSurvey($this->iSurveyid, $this->sSurveyMode, $this->aSurveyOptions, false, $this->LEMdebugLevel);
LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['step'], false, false);
}
/**
* Seems to be a quick fix to avoid the total and max steps to be null...
*/
private function initTotalAndMaxSteps()
{
if (!isset($_SESSION[$this->LEMsessid]['totalsteps'])){
$_SESSION[$this->LEMsessid]['totalsteps'] = 0;
}
if (!isset($_SESSION[$this->LEMsessid]['maxstep'])){
$_SESSION[$this->LEMsessid]['maxstep'] = 0;
}
}
/**
* It checks if user used the browser navigation (prev, next, reload page etc)
* and feed te backpopup variable if needed
*
*/
private function checkIfUseBrowserNav()
{
// retrieve datas from local variable
if (isset($_SESSION[$this->LEMsessid]['LEMpostKey']) && App()->request->getPost('LEMpostKey',$_SESSION[$this->LEMsessid]['LEMpostKey']) != $_SESSION[$this->LEMsessid]['LEMpostKey']){
// then trying to resubmit (e.g. Next, Previous, Submit) from a cached copy of the page
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['step'], false, false, true);// We JumpTo current step without saving: see bug #11404
if (isset($this->aMoveResult['seq']) && App()->request->getPost('thisstep',$this->aMoveResult['seq']) == $this->aMoveResult['seq']){
/* then pressing F5 or otherwise refreshing the current page, which is OK
* Seems OK only when movenext but not with move by index : same with $this->aMoveResult = LimeExpressionManager::GetLastMoveResult(true);
*/
$this->LEMskipReprocessing = true;
$this->move = "movenext"; // so will re-display the survey
}else{
// trying to use browser back buttons, which may be disallowed if no 'previous' button is present
$this->LEMskipReprocessing = true;
$this->move = "movenext"; // so will re-display the survey
$this->bInvalidLastPage = true;
$this->backpopup = gT("Please use the LimeSurvey navigation buttons or index. It appears you attempted to use the browser back button to re-submit a page."); // TODO: twig
}
}
}
/**
* Check quotas
*/
private function checkQuotas()
{
/* quota submitted */
if ( $this->sMove =='confirmquota'){
checkCompletedQuota($this->iSurveyid);
}
}
/**
* Check if the move is clearcancel or confirmquota
*/
private function checkClearCancel()
{
if ( $this->sMove=="clearcancel"){
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['step'], false, false);
}
}
/**
* Set prev step in session depending on move type
* If not in a specific page, prevstep stock the value of step just before it get updated
*/
private function setPrevStep()
{
if (isset($this->move))
{
if(!in_array($this->move,array("clearall","changelang","saveall","reload")))
$_SESSION[$this->LEMsessid]['prevstep'] = $_SESSION[$this->LEMsessid]['step'];
else // Accepted $move without error
$_SESSION[$this->LEMsessid]['prevstep']= $this->move;
}
else
{
// $_SESSION[$this->LEMsessid]['prevstep'] = $_SESSION[$LEMsessid]['step']-1; // Is this needed ?
}
if (!isset($_SESSION[$this->LEMsessid]['prevstep']))
{
$_SESSION[$this->LEMsessid]['prevstep']=$_SESSION[$this->LEMsessid]['prevstep']-1; // this only happens on re-load
}
}
/**
* Define prev step if not set in session.
*/
private function checkPrevStep()
{
if (!isset($_SESSION[$this->LEMsessid]['prevstep'])){
$_SESSION[$this->LEMsessid]['prevstep'] = $_SESSION[$this->LEMsessid]['step']-1; // this only happens on re-load
}
}
/**
* Set the moveResult variable, depending on the user move request
*/
private function setMoveResult()
{
// retrieve datas from local variable
if (isset($_SESSION[$this->LEMsessid]['LEMtokenResume'])){
LimeExpressionManager::StartSurvey($this->aSurveyInfo['sid'], $this->sSurveyMode, $this->aSurveyOptions, false, $this->LEMdebugLevel);
// Do it only if needed : we don't need it if we don't have index
if(isset($_SESSION[$this->LEMsessid]['maxstep']) && $_SESSION[$this->LEMsessid]['maxstep']>$_SESSION[$this->LEMsessid]['step'] && $this->aSurveyInfo['questionindex'] ){
LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['maxstep'], false, false);
}
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['step'],false,false); // if late in the survey, will re-validate contents, which may be overkill
unset($_SESSION[$this->LEMsessid]['LEMtokenResume']);
}else if (!$this->LEMskipReprocessing){
//Move current step ###########################################################################
if ($this->sMove == 'moveprev' && ($this->aSurveyInfo['allowprev'] == 'Y' || $this->aSurveyInfo['questionindex'] > 0)){
$this->aMoveResult = LimeExpressionManager::NavigateBackwards();
if ($this->aMoveResult['at_start']){
$_SESSION[$this->LEMsessid]['step'] = 0;
unset($this->aMoveResult); // so display welcome page again
}
}
if ( $this->sMove == "movenext"){
$this->aMoveResult = LimeExpressionManager::NavigateForwards();
}
if (($this->sMove == 'movesubmit')){
if ($this->sSurveyMode == 'survey'){
$this->aMoveResult = LimeExpressionManager::NavigateForwards();
}else{
// may be submitting from the navigation bar, in which case need to process all intervening questions
// in order to update equations and ensure there are no intervening relevant mandatory or relevant invalid questions
if($this->aSurveyInfo['questionindex']==2) // Must : save actual page , review whole before set finished to true (see #09906), index==1 seems to don't need it : (don't force move)
LimeExpressionManager::StartSurvey($this->iSurveyid, $this->sSurveyMode, $this->aSurveyOptions);
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['totalsteps'] + 1, false);
}
}
if ( $this->sMove=='clearall'){
$this->manageClearAll();
}
if ( $this->sMove=='changelang'){
// jump to current step using new language, processing POST values
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['step'], false, true, true, true); // do process the POST data
}
if (isNumericInt($this->sMove) && $this->aSurveyInfo['questionindex'] == 1){
$this->sMove = (int) $this->sMove;
if ($this->sMove > 0 && (($this->sMove <= $_SESSION[$this->LEMsessid]['step']) || (isset($_SESSION[$this->LEMsessid]['maxstep']) && $this->sMove <= $_SESSION[$this->LEMsessid]['maxstep']))){
$this->aMoveResult = LimeExpressionManager::JumpTo($this->sMove, false);
}
}
elseif ( isNumericInt($this->sMove) && $this->aSurveyInfo['questionindex'] == 2){
$this->sMove = (int) $this->sMove;
$this->aMoveResult = LimeExpressionManager::JumpTo($this->sMove, false, true, true);
}
if ( ! $this->aMoveResult && !($this->sSurveyMode != 'survey' && $_SESSION[$this->LEMsessid]['step'] == 0)){
// Just in case not set via any other means, but don't do this if it is the welcome page
$this->aMoveResult = LimeExpressionManager::GetLastMoveResult(true);
$this->LEMskipReprocessing = true;
}
}
}
/**
* Test if the the moveresult is finished, to decide to set the new $this->sMove value
*/
private function checkIfFinished()
{
// Reload at first page (welcome after click previous fill an empty $this->aMoveResult array
if ( $this->aMoveResult && isset($this->aMoveResult['seq']) ){
// With complete index, we need to revalidate whole group bug #08806. It's actually the only mode where we JumpTo with force
// we already done if move == 'movesubmit', don't do it again
if($this->aMoveResult['finished'] == true && $this->sMove != 'movesubmit' && $this->thissurvey['questionindex']==2){
//LimeExpressionManager::JumpTo(-1, false, false, true);
LimeExpressionManager::StartSurvey($this->iSurveyid, $this->sSurveyMode, $this->aSurveyOptions);
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['totalsteps']+1, false, false, false);// no preview, no save data and NO force
if(!$this->aMoveResult['mandViolation'] && $this->aMoveResult['valid'] && empty($this->aMoveResult['invalidSQs'])){
$this->aMoveResult['finished'] = true;
}
}
if ($this->aMoveResult['finished'] == true){
$this->move = 'movesubmit';
}
if ($this->sMove == "movesubmit" && $this->aMoveResult['finished'] == false){
// then there are errors, so don't finalize the survey
$this->sMove = "movenext"; // so will re-display the survey
$this->bInvalidLastPage = true;
}
}
}
/**
* Increase step in session
*/
private function setStep()
{
if ( $this->aMoveResult && isset($this->aMoveResult['seq']) ){
if ($this->aMoveResult['finished'] != true){
$_SESSION[$this->LEMsessid]['step'] = $this->aMoveResult['seq'] + 1; // step is index base 1
$this->aStepInfo = LimeExpressionManager::GetStepIndexInfo($this->aMoveResult['seq']);
}
}
}
/**
* Display the first page if needed
*/
private function displayFirstPageIfNeeded()
{
// We do not keep the participant session anymore when the same browser is used to answer a second time a survey (let's think of a library PC for instance).
// Previously we used to keep the session and redirect the user to the
// submit page.
if ($this->sSurveyMode != 'survey' && $_SESSION[$this->LEMsessid]['step'] == 0){
$_SESSION[$this->LEMsessid]['test']=time();
display_first_page($this->thissurvey, $this->aSurveyInfo);
Yii::app()->end(); // So we can still see debug messages
}
}
/**
* Perform save all if user asked for it
*/
private function saveAllIfNeeded()
{
// TODO FIXME
// Don't test if save is allowed
if ($this->aSurveyInfo['active'] == "Y" && Yii::app()->request->getPost('saveall')){
$bTokenAnswerPersitance = $this->aSurveyInfo['tokenanswerspersistence'] == 'Y' && $this->iSurveyid!=null && tableExists('tokens_'.$this->iSurveyid);
// must do this here to process the POSTed values
$this->aMoveResult = LimeExpressionManager::JumpTo($_SESSION[$this->LEMsessid]['step'], false); // by jumping to current step, saves data so far
if (!isset($_SESSION[$this->LEMsessid]['scid']) && !$bTokenAnswerPersitance ){
Yii::import("application.libraries.Save");
$cSave = new Save();
// $cSave->showsaveform($this->aSurveyInfo['sid']); // generates a form and exits, awaiting input
$this->aSurveyInfo['aSaveForm'] = $cSave->getSaveFormDatas($this->aSurveyInfo['sid']);
Yii::app()->twigRenderer->renderTemplateFromFile("layout_save.twig", array('oSurvey'=> Survey::model()->findByPk($this->iSurveyid), 'aSurveyInfo'=>$this->aSurveyInfo), false);
}else{
// Intentional retest of all conditions to be true, to make sure we do have tokens and surveyid
// Now update lastpage to $_SESSION[$this->LEMsessid]['step'] in SurveyDynamic, otherwise we land on
// the previous page when we return.
$iResponseID = $_SESSION[$this->LEMsessid]['srid'];
$oResponse = SurveyDynamic::model($this->iSurveyid)->findByPk($iResponseID);
$oResponse->lastpage = $_SESSION[$this->LEMsessid]['step'];
$oResponse->save();
}
}
}
/**
* perform save submit if asked by user
* called from save survey
*/
private function saveSubmitIfNeeded()
{
if ($this->aSurveyInfo['active'] == "Y" && Yii::app()->request->getParam('savesubmit') ){
// The response from the save form
// CREATE SAVED CONTROL RECORD USING SAVE FORM INFORMATION
Yii::import("application.libraries.Save");
$cSave = new Save();
// Try to save survey
$aResult = $cSave->saveSurvey();
if (!$aResult['success']){
$aPopup = $this->popup = $aResult['aSaveErrors'];
}else{
$aPopup = $this->popup = array($aResult['message']);
}
Yii::app()->clientScript->registerScript('startPopup',"LSvar.startPopups=".json_encode($aPopup).";",CClientScript::POS_HEAD);
Yii::app()->clientScript->registerScript('showStartPopups',"showStartPopups();",CClientScript::POS_END);
// reshow the form if there is an error
if (!empty($aResult['aSaveErrors'])){
$this->aSurveyInfo['aSaveForm'] = $cSave->getSaveFormDatas($this->aSurveyInfo['sid']);
Yii::app()->twigRenderer->renderTemplateFromFile("layout_save.twig", array('oSurvey'=> Survey::model()->findByPk($this->iSurveyid), 'aSurveyInfo'=>$this->aSurveyInfo), false);
}
$this->aMoveResult = LimeExpressionManager::GetLastMoveResult(true);
$this->LEMskipReprocessing = true;
}
}
/**
* check mandatory questions if necessary
* CHECK IF ALL CONDITIONAL MANDATORY QUESTIONS THAT APPLY HAVE BEEN ANSWERED
*/
private function setNotAnsweredAndNotValidated()
{
global $notanswered;
// TODO: check that line:
$this->notvalidated = $notanswered;
$this->notanswered = $notanswered;
if (!$this->aMoveResult['finished']){
$unansweredSQList = $this->aMoveResult['unansweredSQs']; // A list of the unanswered responses created via the global variable $notanswered. Should be $oResponse->unanswereds
if (strlen($unansweredSQList) > 0){
$this->notanswered =explode('|', $unansweredSQList);
}else{
$this->notanswered = array();