-
Notifications
You must be signed in to change notification settings - Fork 988
/
ResponsesController.php
1132 lines (1037 loc) · 47.2 KB
/
ResponsesController.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
/**
* class ResponsesController
**/
class ResponsesController extends LSBaseController
{
/**
* responses constructor.
* @param $controller
* @param $id
*/
public function __construct($controller, $id)
{
parent::__construct($controller, $id);
App()->loadHelper('surveytranslator');
}
/**
* Set filters for all actions
* @return string[]
*/
public function filters()
{
return [
'postOnly + delete, deleteSingle, deleteAttachments'
];
}
/**
* Override default getActionParams
* @return array
*/
public function getActionParams()
{
return array_merge($_GET, $_POST);
}
/**
* this is part of renderWrappedTemplate implement in old responses.php
*
* @param string $view
* @return bool
*/
public function beforeRender($view)
{
App()->getClientScript()->registerCssFile(App()->getConfig('publicstyleurl') . 'browse.css');
$surveyId = (int)App()->request->getParam('surveyId');
$oSurvey = Survey::model()->findByPk($surveyId);
$this->aData['subaction'] = gT("Responses and statistics");
$this->aData['display']['menu_bars']['browse'] = gT('Browse responses'); // browse is independent of the above
$this->aData['title_bar']['title'] = gT('Browse responses') . ': ' . $oSurvey->currentLanguageSettings->surveyls_title;
$this->aData['topBar']['type'] = 'responses';
$this->layout = 'layout_questioneditor';
return parent::beforeRender($view);
}
/**
* @param int $surveyId
* @param string $token
*/
public function actionViewbytoken(int $surveyId, string $token): void
{
// Get Response ID from token
$oResponse = SurveyDynamic::model($surveyId)->findByAttributes(['token' => $token]);
if (!$oResponse) {
App()->user->setFlash('error', gT("Sorry, this response was not found."));
$this->redirect(["responses/browse/surveyId/{$surveyId}"]);
} else {
$this->redirect(["responses/view/", 'surveyId' => $surveyId, 'id' => $oResponse->id]);
}
}
/**
* View a single response as queXML PDF
*
* @param int $surveyId
* @param int $id
* @param string $browseLang
* @throws CException
* @throws CHttpException
*/
public function actionViewquexmlpdf(int $surveyId, int $id, string $browseLang = ''): void
{
if (Permission::model()->hasSurveyPermission($surveyId, 'responses', 'read')) {
$aData = $this->getData($surveyId, $id, $browseLang);
$sBrowseLanguage = $aData['language'];
Yii::import("application.libraries.admin.quexmlpdf", true);
$quexmlpdf = new quexmlpdf();
$quexmlpdf->applyGlobalSettings();
// Setting the selected language for printout
App()->setLanguage($sBrowseLanguage);
$quexmlpdf->setLanguage($sBrowseLanguage);
set_time_limit(120);
App()->loadHelper('export');
$quexml = quexml_export($surveyId, $sBrowseLanguage, $id);
$quexmlpdf->create($quexmlpdf->createqueXML($quexml));
$quexmlpdf->Output("$surveyId-$id-queXML.pdf", 'D');
} else {
App()->user->setFlash('error', gT("You do not have permission to access this page."));
$this->redirect(['surveyAdministration/view', 'surveyid' => $surveyId]);
}
}
/**
* View a single response in detail
*
* @param int $surveyId
* @param int $id
* @param string $browseLang
* @throws CException
* @throws CHttpException
*/
public function actionView(int $surveyId, int $id, string $browseLang = ''): void
{
// logging for webserver when parameter is somehting like $surveyid=125<script ...
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (!is_numeric(Yii::app()->request->getParam('id'))) {
throw new CHttpException(403, gT("Invalid response ID"));
}
$survey = Survey::model()->findByPk($surveyId);
if (!Permission::model()->hasSurveyPermission($surveyId, 'responses', 'read')) {
App()->user->setFlash('error', gT("You do not have permission to access this page."));
$this->redirect(['surveyAdministration/view', 'surveyid' => $surveyId]);
App()->end(); // More clear, uneeded.
}
/* TODO : Check if response still exist, after checking survey */
$aData = $this->getData($surveyId, $id, $browseLang);
$sBrowseLanguage = $aData['language'];
extract($aData, EXTR_OVERWRITE);
$fieldmap = createFieldMap($survey, 'full', false, false, $aData['language']);
// just used to check if the token exists for the given response id before we create the real query
$response = SurveyDynamic::model($surveyId)->find('id=:id', [':id' => $id]);
// Boolean : show (or not) the token
$bHaveToken = $survey->anonymized == "N"
&& tableExists('tokens_' . $surveyId)
&& isset($response->tokens);
if (!Permission::model()->hasSurveyPermission($surveyId, 'tokens', 'read')) {
// If not allowed to read: remove it
unset($fieldmap['token']);
$bHaveToken = false;
}
//add token to top of list if survey is not private
if ($bHaveToken) {
$fnames[] = ["token", gT("Access code"), 'code' => 'token'];
$fnames[] = ["firstname", gT("First name"), 'code' => 'firstname']; // or token:firstname ?
$fnames[] = ["lastname", gT("Last name"), 'code' => 'lastname'];
$fnames[] = ["email", gT("Email"), 'code' => 'email'];
$customTokenAttributes = $survey->tokenAttributes;
foreach ($customTokenAttributes as $attributeName => $tokenAttribute) {
$tokenAttributeDescription = ($tokenAttribute['description'] != '') ? $tokenAttribute['description'] : $attributeName;
$fnames[] = [$attributeName, $tokenAttributeDescription, 'code' => $attributeName];
}
}
if ($survey->isDateStamp) {
$fnames[] = ["submitdate", gT("Submission date"), gT("Completed"), "0", 'D', 'code' => 'submitdate'];
}
$fnames[] = ["completed", gT("Completed"), "0"];
foreach ($fieldmap as $field) {
if ($field['fieldname'] == 'lastpage' || $field['fieldname'] == 'submitdate') {
continue;
}
if ($field['type'] == 'interview_time') {
continue;
}
if ($field['type'] == 'page_time') {
continue;
}
if ($field['type'] == 'answer_time') {
continue;
}
//$question = $field['question'];
$question = viewHelper::getFieldText($field);
if ($field['type'] != Question::QT_VERTICAL_FILE_UPLOAD) {
$fnames[] = [
$field['fieldname'],
viewHelper::getFieldText($field),
'code' => viewHelper::getFieldCode($field, ['LEMcompat' => true])
];
} elseif ($field['aid'] !== 'filecount') {
$qidattributes = QuestionAttribute::model()->getQuestionAttributes($field['qid']);
for ($i = 0; $i < $qidattributes['max_num_of_files']; $i++) {
$filenum = sprintf(gT("File %s"), $i + 1);
if ($qidattributes['show_title'] == 1) {
$fnames[] = [
$field['fieldname'],
"{$filenum} - {$question} (" . gT('Title') . ")",
'code' => viewHelper::getFieldCode($field) . '(title)',
"type" => Question::QT_VERTICAL_FILE_UPLOAD,
"metadata" => "title",
"index" => $i
];
}
if ($qidattributes['show_comment'] == 1) {
$fnames[] = [
$field['fieldname'],
"{$filenum} - {$question} (" . gT('Comment') . ")",
'code' => viewHelper::getFieldCode($field) . '(comment)',
"type" => Question::QT_VERTICAL_FILE_UPLOAD,
"metadata" => "comment",
"index" => $i
];
}
$fnames[] = [
$field['fieldname'],
"{$filenum} - {$question} (" . gT('File name') . ")",
'code' => viewHelper::getFieldCode($field) . '(name)',
"type" => "|",
"metadata" => "name",
"index" => $i,
'qid' => $field['qid']
];
$fnames[] = [
$field['fieldname'],
"{$filenum} - {$question} (" . gT('File size') . ")",
'code' => viewHelper::getFieldCode($field) . '(size)',
"type" => "|",
"metadata" => "size",
"index" => $i
];
}
} else {
$fnames[] = [$field['fieldname'], gT("File count")];
}
}
$nfncount = count($fnames) - 1;
if ($id < 1) {
$id = 1;
}
$exist = SurveyDynamic::model($surveyId)->exist($id);
$next = SurveyDynamic::model($surveyId)->next($id, true);
$previous = SurveyDynamic::model($surveyId)->previous($id, true);
$aData['exist'] = $exist;
$aData['next'] = $next;
$aData['previous'] = $previous;
$aData['id'] = $id;
if ($exist) {
$oPurifier = new CHtmlPurifier();
//SHOW INDIVIDUAL RECORD
$oCriteria = new CDbCriteria();
if ($bHaveToken) {
$oCriteria = SurveyDynamic::model($surveyId)->addTokenCriteria($oCriteria);
}
$oCriteria->addCondition("id = {$id}");
$iIdresult = SurveyDynamic::model($surveyId)->find($oCriteria);
if ($bHaveToken) {
$aResult = array_merge(
$iIdresult->tokens->decrypt()->attributes,
$iIdresult->decrypt()->attributes
);
} else {
$aResult = $iIdresult->decrypt()->attributes;
}
$id = $aResult['id'];
$rlanguage = $aResult['startlanguage'];
$aData['bHasFile'] = false;
if (isset($rlanguage)) {
$aData['rlanguage'] = $rlanguage;
}
$highlight = false;
$aData['answers'] = [];
for ($i = 0; $i < $nfncount + 1; $i++) {
if ($fnames[$i][0] != 'completed' && is_null($aResult[$fnames[$i][0]])) {
continue; // irrelevant, so don't show
}
$inserthighlight = '';
if ($highlight) {
$inserthighlight = "class='highlight'";
}
if ($fnames[$i][0] == 'completed') {
if ($aResult['submitdate'] == null || $aResult['submitdate'] == "N") {
$answervalue = "N";
} else {
$answervalue = "Y";
}
} elseif (isset($fnames[$i]['type']) && $fnames[$i]['type'] == Question::QT_VERTICAL_FILE_UPLOAD) {
// File upload question type.
$index = $fnames[$i]['index'];
$metadata = $fnames[$i]['metadata'];
$phparray = json_decode_ls($aResult[$fnames[$i][0]]);
if (isset($phparray[$index])) {
switch ($metadata) {
case "size":
$answervalue = sprintf(gT("%s KB"), intval($phparray[$index][$metadata]));
break;
case "name":
$answervalue = CHtml::link(
htmlspecialchars(
(string) $oPurifier->purify(rawurldecode((string) $phparray[$index][$metadata]))
),
$this->createUrl(
"responses/downloadfile",
[
"surveyId" => $surveyId,
"responseId" => $id,
"qid" => $fnames[$i]['qid'],
"index" => $index
]
)
);
break;
default:
$answervalue = htmlspecialchars(
strip_tags(
stripJavaScript($phparray[$index][$metadata])
)
);
}
$aData['bHasFile'] = true;
} else {
$answervalue = "";
}
} else {
$answervalue = htmlspecialchars(
viewHelper::flatten(
stripJavaScript(
getExtendedAnswer(
$surveyId,
$fnames[$i][0],
$aResult[$fnames[$i][0]],
$sBrowseLanguage
)
)
),
ENT_QUOTES
);
}
$aData['inserthighlight'] = $inserthighlight;
$aData['fnames'] = $fnames;
$aData['answers'][] = [
'answervalue' => $answervalue,
'i' => $i
];
}
} else {
App()->session['flashmessage'] = gT("This response ID is invalid.");
}
$aData['sidemenu']['state'] = false;
// This resets the url on the close button to go to the upper view
$aData['closeUrl'] = $this->createUrl("responses/browse/", ['surveyId' => $surveyId]);
$topbarData = TopbarConfiguration::getResponsesTopbarData($survey->sid);
$topbarData = array_merge($topbarData, $aData);
$aData['topbar']['middleButtons'] = $this->renderPartial(
'partial/topbarBtns/responseViewTopbarRight_view',
$topbarData,
true
);
$this->aData = $aData;
$this->render('browseidrow_view', [
'id' => $aData['id'],
'surveyid' => $aData['surveyId'],
'answers' => $aData['answers'],
'inserthighlight' => $aData['inserthighlight'],
'fnames' => $aData['fnames'],
]);
}
/**
* Shows the responses summary
*
* @param int $surveyId
*/
public function actionIndex(int $surveyId): void
{
// logging for webserver when parameter is somehting like $surveyid=125<script ...
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
$survey = Survey::model()->findByPk($surveyId);
$aData = $this->getData($surveyId);
$aData['num_total_answers'] = SurveyDynamic::model($surveyId)->count();
$aData['num_completed_answers'] = SurveyDynamic::model($surveyId)->count('submitdate IS NOT NULL');
if ($survey->hasTokensTable && Permission::model()->hasSurveyPermission($surveyId, 'tokens', 'read')) {
$aData['with_token'] = App()->db->schema->getTable($survey->tokensTableName);
$aData['tokeninfo'] = Token::model($surveyId)->summary();
}
$topbarData = TopbarConfiguration::getResponsesTopbarData($survey->sid);
$aData['topbar']['middleButtons'] = $this->renderPartial(
'partial/topbarBtns/leftSideButtons',
$topbarData,
true
);
$this->aData = $aData;
$this->render('browseindex_view', [
'num_completed_answers' => $aData['num_completed_answers'],
'num_total_answers' => $aData['num_total_answers'],
'tokeninfo' => $aData['tokeninfo'],
'with_token' => $aData['with_token']
]);
}
/**
* Show responses for survey
*
* @param int $surveyId
* @return void
*/
public function actionBrowse(int $surveyId): void
{
// logging for webserver when parameter is somehting like $surveyid=125<script ...
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
$survey = Survey::model()->findByPk($surveyId);
$displaymode = App()->request->getPost('displaymode', null);
if ($displaymode !== null) {
$this->setGridDisplay($displaymode);
}
if (Permission::model()->hasSurveyPermission($surveyId, 'responses', 'read')) {
App()->getClientScript()->registerScriptFile(
App()->getConfig('adminscripts') .
'listresponse.js',
LSYii_ClientScript::POS_BEGIN
);
App()->getClientScript()->registerScriptFile(
App()->getConfig('adminscripts') .
'tokens.js',
LSYii_ClientScript::POS_BEGIN
);
// Basic data for the view
$aData = $this->getData($surveyId);
$aData['surveyid'] = $surveyId;
$aData['sidemenu']['state'] = false;
$aData['issuperadmin'] = Permission::model()->hasGlobalPermission('superadmin');
$aData['hasUpload'] = hasFileUploadQuestion($surveyId);
$aData['fieldmap'] = createFieldMap($survey, 'full', true, false, $aData['language']);
$aData['dateformatdetails'] = getDateFormatData(App()->session['dateformat']);
////////////////////
// Setting the grid
// Basic variables
$bHaveToken = $survey->anonymized == "N" && tableExists('tokens_' . $surveyId) && Permission::model()->hasSurveyPermission($surveyId, 'tokens', 'read'); // Boolean : show (or not) the token
$model = SurveyDynamic::model($surveyId);
$model->bEncryption = true;
// Reset filters from stats
if (App()->request->getParam('filters') == "reset") {
App()->user->setState('sql_' . $surveyId, '');
}
// Page size
if (App()->request->getParam('pageSize')) {
App()->user->setState('pageSize', (int)App()->request->getParam('pageSize'));
}
// Model filters
if (isset($_SESSION['survey_' . $surveyId])) {
$sessionSurveyArray = App()->session->get('survey_' . $surveyId);
$visibleColumns = $sessionSurveyArray['filteredColumns'] ?? null;
if (!empty($visibleColumns)) {
$model->setAttributes($visibleColumns, false);
}
}
// Using safe search on dynamic column names would be far too much complex.
// So we pass over the safe validation and directly set attributes (second parameter of setAttributes to false).
// see: http://www.yiiframework.com/wiki/161/understanding-safe-validation-rules/
// see: http://www.yiiframework.com/doc/api/1.1/CModel#setAttributes-detail
if (App()->request->getParam('SurveyDynamic')) {
$model->setAttributes(App()->request->getParam('SurveyDynamic'), false);
}
// Virtual attributes filters
// Filters on related tables need virtual filters attributes in main model (class variables)
// Those virtual filters attributes are not set by the setAttributes, they must be set manually
// @see: http://www.yiiframework.com/wiki/281/searching-and-sorting-by-related-model-in-cgridview/
$aVirtualFilters = ['completed_filter', 'firstname_filter', 'lastname_filter', 'email_filter'];
foreach ($aVirtualFilters as $sFilterName) {
$aParam = App()->request->getParam('SurveyDynamic');
if (!empty($aParam[$sFilterName])) {
$model->$sFilterName = $aParam[$sFilterName];
}
}
// Sets which columns to filter
$filteredColumns = !empty(isset($_SESSION['survey_' . $surveyId]['filteredColumns'])) ? $_SESSION['survey_' . $surveyId]['filteredColumns'] : null;
$aData['filteredColumns'] = $filteredColumns;
// rendering
$aData['model'] = $model;
$aData['bHaveToken'] = $bHaveToken;
$aData['aDefaultColumns'] = $model->defaultColumns; // Some specific columns
// Page size
$aData['pageSize'] = App()->user->getState('pageSize', App()->params['defaultPageSize']);
$topbarData = TopbarConfiguration::getResponsesTopbarData($survey->sid);
$aData['topbar']['middleButtons'] = $this->renderPartial(
'partial/topbarBtns/leftSideButtons',
$topbarData,
true
);
$this->aData = $aData;
$this->render('listResponses_view', [
'surveyid' => $aData['surveyid'],
'dateformatdetails' => $aData['dateformatdetails'],
'model' => $aData['model'],
'bHaveToken' => $aData['bHaveToken'],
'language' => $aData['language'],
'pageSize' => $aData['pageSize'],
'fieldmap' => $aData['fieldmap'],
'filteredColumns' => $aData['filteredColumns'],
]);
} else {
App()->user->setFlash('error', gT("You do not have permission to access this page."));
$this->redirect(['surveyAdministration/view', 'surveyid' => $surveyId]);
}
}
/**
* Saves the hidden columns for response browsing in the session
* @access public
* @param int $surveyId
*/
public function actionSetFilteredColumns(int $surveyId): void
{
// logging for webserver when parameter is something like $surveyid=125<script ...
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (Permission::model()->hasSurveyPermission($surveyId, 'responses', 'read')) {
$aFilteredColumns = [];
$aColumns = (array)App()->request->getPost('columns');
if (isset($aColumns)) {
if (!empty($aColumns)) {
foreach ($aColumns as $sColumn) {
if (isset($sColumn)) {
$aFilteredColumns[] = $sColumn;
}
}
$_SESSION['survey_' . $surveyId]['filteredColumns'] = $aFilteredColumns;
} else {
$_SESSION['survey_' . $surveyId]['filteredColumns'] = [];
}
}
}
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
/**
* Deletes multiple responses (massive action)
*
* @access public
* @param int $surveyId
* @return void
* @throws CDbException
* @throws CException
* @throws CHttpException
*/
public function actionDelete(int $surveyId): void
{
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (!Permission::model()->hasSurveyPermission($surveyId, 'responses', 'delete')) {
throw new CHttpException(403, gT("You do not have permission to access this page."));
}
if (!App()->getRequest()->isPostRequest) {
throw new CHttpException(405, gT("Invalid action"));
}
Yii::import('application.helpers.admin.ajax_helper', true);
$ResponseId = (App()->request->getPost('sItems') != '') ? json_decode(App()->request->getPost('sItems', '')) : json_decode(App()->request->getParam('sResponseId', ''), true);
if (App()->request->getPost('modalTextArea') != '') {
$ResponseId = explode(',', App()->request->getPost('modalTextArea', ''));
foreach ($ResponseId as $key => $sResponseId) {
$ResponseId[$key] = str_replace(' ', '', $sResponseId);
}
}
$aResponseId = (is_array($ResponseId)) ? $ResponseId : [$ResponseId];
$errors = 0;
$timingErrors = 0;
foreach ($aResponseId as $iResponseId) {
$resultErrors = $this->deleteResponse($surveyId, $iResponseId);
$errors += $resultErrors['numberOfErrors'];
$timingErrors += $resultErrors['numberOfTimingErrors'];
}
if ($errors || $timingErrors) {
$message = ($errors) ? ngT("A response was not deleted.|{n} responses were not deleted.", $errors) : "";
$message .= ($timingErrors) ? ngT("A timing record was not deleted.|{n} timing records were not deleted.", $errors) : "";
if (App()->getRequest()->isAjaxRequest) {
ls\ajax\AjaxHelper::outputError($message);
} else {
App()->user->setFlash('error', $message);
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
}
if (App()->getRequest()->isAjaxRequest) {
ls\ajax\AjaxHelper::outputSuccess(gT('Response(s) deleted.'));
}
App()->user->setFlash('success', gT('Response(s) deleted.'));
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
/**
* Deletes a single response and redirects to the gridview.
*
* @param int $surveyId -- the survey id
* @param int $responseId -- the response id to be deleted
* @throws CDbException
* @throws CHttpException
*/
public function actionDeleteSingle(int $surveyId, int $responseId): void
{
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (!is_numeric(Yii::app()->request->getParam('responseId'))) {
throw new CHttpException(403, gT("Invalid response ID"));
}
if (!Permission::model()->hasSurveyPermission($surveyId, 'responses', 'delete')) {
throw new CHttpException(403, gT("You do not have permission to access this page."));
}
$resultErrors = $this->deleteResponse($surveyId, $responseId);
if ($resultErrors['numberOfErrors'] > 0 || $resultErrors['numberOfTimingErrors']) {
$message = gt('Response could not be deleted');
App()->user->setFlash('error', $message);
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
App()->user->setFlash('success', gT('Response deleted.'));
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
/**
* Download individual file by response and filename
*
* @access public
* @param int $surveyId : survey id
* @param int $responseId
* @param int $qid
* @param int $index
* @return void
* @throws CHttpException
*/
public function actionDownloadfile(int $surveyId, int $responseId, int $qid, int $index): void
{
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (!is_numeric(Yii::app()->request->getParam('responseId'))) {
throw new CHttpException(403, gT("Invalid response ID"));
}
if (!is_numeric(Yii::app()->request->getParam('qid'))) {
throw new CHttpException(403, gT("Invalid question ID"));
}
$oSurvey = Survey::model()->findByPk($surveyId);
if (!$oSurvey->isActive) {
App()->user->setFlash('error', gT('Sorry, this file was not found.'));
$this->redirect(["surveyAdministration/view", "surveyid" => $surveyId]);
}
if (Permission::model()->hasSurveyPermission($surveyId, 'responses', 'read')) {
$oResponse = Response::model($surveyId)->findByPk($responseId);
if (is_null($oResponse)) {
App()->user->setFlash('error', gT('Found no response with ID %d'), $responseId);
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
$aQuestionFiles = $oResponse->getFiles($qid);
if (isset($aQuestionFiles[$index])) {
$aFile = $aQuestionFiles[$index];
// Real path check from here: https://stackoverflow.com/questions/4205141/preventing-directory-traversal-in-php-but-allowing-paths
$sDir = Yii::app()->getConfig('uploaddir') . DIRECTORY_SEPARATOR . "surveys" . DIRECTORY_SEPARATOR . $surveyId . DIRECTORY_SEPARATOR . "files" . DIRECTORY_SEPARATOR;
$sFileRealName = $sDir . $aFile['filename'];
$sRealUserPath = get_absolute_path($sFileRealName);
if ($sRealUserPath === false) {
throw new CHttpException(404, "File not found.");
} elseif (strpos((string) $sRealUserPath, $sDir) !== 0) {
throw new CHttpException(403, "File cannot be accessed.");
} else {
$mimeType = CFileHelper::getMimeType($sFileRealName, null, false);
if (is_null($mimeType)) {
$mimeType = "application/octet-stream";
}
@ob_clean();
header('Content-Description: File Transfer');
header('Content-Type: ' . $mimeType);
header('Content-Disposition: attachment; filename="' . sanitize_filename(rawurldecode((string) $aFile['name'])) . '"');
header('Content-Transfer-Encoding: binary');
header('Expires: 0');
header("Cache-Control: must-revalidate, no-store, no-cache");
header('Content-Length: ' . filesize($sFileRealName));
readfile($sFileRealName);
exit;
}
}
App()->user->setFlash('error', gT('Sorry, this file was not found.'));
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
} else {
throw new CHttpException(403, gT("You do not have permission to access this page."));
}
}
/**
* Construct a zip files from a list of response
*
* @access public
* @param int $surveyId : survey id
* @param string $responseIds : list of responses as string
* @return void application/zip
* @throws CException
*/
public function actionDownloadfiles(int $surveyId, string $responseIds = ''): void
{
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (Permission::model()->hasSurveyPermission($surveyId, 'responses', 'read')) {
$oSurvey = Survey::model()->findByPk($surveyId);
if (!$oSurvey->isActive) {
App()->user->setFlash('error', gT('Sorry, this file was not found.'));
$this->redirect(["surveyAdministration/view", "surveyid" => $surveyId]);
}
if (!$responseIds) {
// No response id : get all survey files
$oCriteria = new CDbCriteria();
$oCriteria->select = "id";
$oSurvey = SurveyDynamic::model($surveyId);
$aResponseId = $oSurvey->getCommandBuilder()
->createFindCommand($oSurvey->tableSchema, $oCriteria)
->queryColumn();
} else {
$aResponseId = explode(",", $responseIds);
}
if (!empty($aResponseId)) {
// Now, zip all the files in the filelist
if (count($aResponseId) === 1) {
$zipfilename = "Files_for_survey_{$surveyId}_response_{$aResponseId[0]}.zip";
} else {
$zipfilename = "Files_for_survey_{$surveyId}.zip";
}
$this->zipFiles($surveyId, $aResponseId, $zipfilename);
} else {
// No response : redirect to browse with a alert
App()->user->setFlash('error', gT('The requested files do not exist on the server.'));
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
} else {
throw new CHttpException(403, gT("You do not have permission to access this page."));
}
}
/**
* Delete all uploaded files for one response.
*
* @param int $surveyId
* @param int|null $responseId
* @return void
* @throws CException
* @throws CHttpException
*/
public function actionDeleteAttachments(int $surveyId, int $responseId = null): void
{
if (!is_numeric(Yii::app()->request->getParam('surveyId'))) {
throw new CHttpException(403, gT("Invalid survey ID"));
}
if (!Permission::model()->hasSurveyPermission($surveyId, 'responses', 'update')) {
throw new CHttpException(403, gT("You do not have permission to access this page."));
}
$request = App()->request;
if (!$request->isPostRequest) {
throw new CHttpException(405, gT("Invalid action"));
}
$stringItems = json_decode($request->getPost('sItems', ''));
// Cast all ids to int.
$items = array_map(
function ($id) {
return (int)$id;
},
is_array($stringItems) ? $stringItems : []
);
$responseIds = $responseId !== null ? [$responseId] : $items;
Yii::import('application.helpers.admin.ajax_helper', true);
$allErrors = [];
$allSuccess = 0;
foreach ($responseIds as $responseIdLoop) {
$response = Response::model($surveyId)->findByPk($responseIdLoop);
if ($response !== null) {
[$success, $errors] = $response->deleteFilesAndFilename();
if (empty($errors)) {
$allSuccess += $success;
} else {
// Could not delete all files.
$allErrors = array_merge($allErrors, $errors);
}
} else {
$allErrors[] = sprintf(gT('Found no response with ID %d'), $responseIdLoop);
}
}
if (!empty($allErrors)) {
$message = gT('Error: Could not delete some files: ') . implode(', ', $allErrors);
if ($request->isAjaxRequest) {
ls\ajax\AjaxHelper::outputError(
$message
);
App()->end();
}
App()->user->setFlash('error', $message);
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
$message = sprintf(ngT('%d file deleted.|%d files deleted.', $allSuccess), $allSuccess);
if ($request->isAjaxRequest) {
ls\ajax\AjaxHelper::outputSuccess($message);
App()->end();
}
App()->user->setFlash('success', $message);
$this->redirect(["responses/browse", "surveyId" => $surveyId]);
}
/**
* Time statistics for responses
*
* @param int $surveyId
* @return void
*/
public function actionTime(int $surveyId): void
{
$aData = $this->getData($surveyId);
$aData['columns'] = [
[
'header' => gT('ID'),
'name' => 'id',
'value' => '$data->id',
'headerHtmlOptions' => ['class' => ''],
'htmlOptions' => ['class' => '']
],
[
'header' => gT('Total time'),
'name' => 'interviewtime',
'value' => '$data->interviewtime'
]
];
$fields = createTimingsFieldMap($surveyId, 'full', true, false, $aData['language']);
foreach ($fields as $fielddetails) {
// headers for answer id and time data
if ($fielddetails['type'] === 'id') {
$fnames[] = [$fielddetails['fieldname'], $fielddetails['question']];
}
if ($fielddetails['type'] === 'interview_time') {
$fnames[] = [$fielddetails['fieldname'], gT('Total time')];
}
if ($fielddetails['type'] === 'page_time') {
$fnames[] = [$fielddetails['fieldname'], gT('Group') . ": " . $fielddetails['group_name']];
$aData['columns'][] = [
'header' => gT('Group: ') . $fielddetails['group_name'],
'name' => $fielddetails['fieldname']
];
}
if ($fielddetails['type'] === 'answer_time') {
$fnames[] = [$fielddetails['fieldname'], gT('Question') . ": " . $fielddetails['title']];
$aData['columns'][] = [
'header' => gT('Question: ') . $fielddetails['title'],
'name' => $fielddetails['fieldname']
];
}
}
$aData['columns'][] = [
'name' => 'actions',
'type' => 'raw',
'header' => gT("Action"),
'headerHtmlOptions' => ['class' => 'ls-sticky-column'],
'filterHtmlOptions' => ['class' => 'ls-sticky-column'],
'htmlOptions' => ['class' => 'ls-sticky-column']
];
// Set number of page
if (App()->request->getParam('pageSize')) {
App()->user->setState('pageSize', (int)App()->request->getParam('pageSize'));
}
//interview Time statistics
$aData['model'] = SurveyTimingDynamic::model($surveyId);
$aData['pageSize'] = App()->user->getState('pageSize', Yii::app()->params['defaultPageSize']);
$aData['statistics'] = SurveyTimingDynamic::model($surveyId)->statistics();
$aData['num_total_answers'] = SurveyDynamic::model($surveyId)->count();
$aData['num_completed_answers'] = SurveyDynamic::model($surveyId)->count('submitdate IS NOT NULL');
//$aData['topBar']['name'] = 'baseTopbar_view';
//$aData['topBar']['leftSideView'] = 'responsesTopbarLeft_view';
$topbarData = TopbarConfiguration::getResponsesTopbarData($surveyId);
$aData['topbar']['middleButtons'] = $this->renderPartial(
'partial/topbarBtns/leftSideButtons',
$topbarData,
true
);
$this->aData = $aData;
$this->render('browsetimerow_view', [
'model' => $aData['model'],
'surveyId' => $aData['surveyId'],
'language' => $aData['language'],
'pageSize' => $aData['pageSize'],
'columns' => $aData['columns'],
'statistics' => $aData['statistics'],
]);
}
/**
* Responsible for setting the session variables for attribute map page redirect
* @param bool $unset
* @param int|null $surveyId
*/
public function actionSetSession(bool $unset = false, int $surveyId = null): void
{
unset(App()->session['responsesid']);
if (!$unset) {
App()->session['responsesid'] = App()->request->getPost('itemsid');
} else {
$this->redirect(["admin/export", "sa" => "exportresults", "surveyid" => $surveyId]);
}
}
/**
* Change the value of the max characters to elipsize headers/questions in response grid.
* It's called via ajax request
*
* @param string $displaymode
* @return void
*/
public function setGridDisplay($displaymode): void
{
if ($displaymode === 'extended') {
App()->user->setState('responsesGridSwitchDisplayState', 'extended');
App()->user->setState('defaultEllipsizeHeaderValue', 1000);
App()->user->setState('defaultEllipsizeQuestionValue', 1000);
} else {
App()->user->setState('responsesGridSwitchDisplayState', 'compact');
App()->user->setState('defaultEllipsizeHeaderValue', App()->params['defaultEllipsizeHeaderValue']);
App()->user->setState('defaultEllipsizeQuestionValue', App()->params['defaultEllipsizeQuestionValue']);
}
}
/**
* Supply an array with the responseIds and all files will be added to the zip
* and it will be be spit out on success
*
* @param int $surveyId
* @param array $responseId
* @param string $zipfilename
*/
private function zipFiles(int $surveyId, array $responseId, string $zipfilename): void
{
$tmpdir = App()->getConfig('uploaddir') . DIRECTORY_SEPARATOR . "surveys" . DIRECTORY_SEPARATOR . $surveyId . DIRECTORY_SEPARATOR . "files" . DIRECTORY_SEPARATOR;
$filelist = [];
$responses = Response::model($surveyId)->findAllByPk($responseId);
$filecount = 0;
foreach ($responses as $response) {
foreach ($response->getFiles() as $fileInfo) {
$filecount++;
/*
* Now add the file to the archive, prefix files with responseid_index to keep them
* unique. This way we can have 234_1_image1.gif, 234_2_image1.gif as it could be