-
Notifications
You must be signed in to change notification settings - Fork 988
/
Survey_Common_Action.php
1453 lines (1271 loc) · 59 KB
/
Survey_Common_Action.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
/*
* 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.
*
*/
/**
* Survey Common Action
*
* This controller contains common functions for survey related views.
*
* @package LimeSurvey
* @subpackage Backend
* @author Shitiz Garg
*/
class Survey_Common_Action extends CAction
{
public function __construct($controller=null, $id=null)
{
parent::__construct($controller, $id);
Yii::app()->request->updateNavigationStack();
// Make sure viewHelper can be autoloaded
Yii::import('application.helpers.viewHelper');
}
/**
* Override runWithParams() implementation in CAction to help us parse
* requests with subactions.
*
* @param array $params URL Parameters
*/
public function runWithParams($params)
{
// Default method that would be called if the subaction and run() do not exist
$sDefault = 'index';
// Check for a subaction
if (empty($params['sa']))
{
$sSubAction = $sDefault; // default
}
else
{
$sSubAction = $params['sa'];
}
// Check if the class has the method
$oClass = new ReflectionClass($this);
if (!$oClass->hasMethod($sSubAction))
{
// If it doesn't, revert to default Yii method, that is run() which should reroute us somewhere else
$sSubAction = 'run';
}
// Populate the params. eg. surveyid -> iSurveyId
$params = $this->_addPseudoParams($params);
if (!empty($params['iSurveyId'])) {
LimeExpressionManager::SetSurveyId($params['iSurveyId']); // must be called early - it clears internal cache if a new survey is being used
}
// Check if the method is public and of the action class, not its parents
// ReflectionClass gets us the methods of the class and parent class
// If the above method existence check passed, it might not be neceessary that it is of the action class
$oMethod = new ReflectionMethod($this, $sSubAction);
// Get the action classes from the admin controller as the urls necessarily do not equal the class names. Eg. survey -> surveyaction
$aActions = Yii::app()->getController()->getActionClasses();
if(empty($aActions[$this->getId()]) || strtolower($oMethod->getDeclaringClass()->name) != strtolower($aActions[$this->getId()]) || !$oMethod->isPublic())
{
// Either action doesn't exist in our whitelist, or the method class doesn't equal the action class or the method isn't public
// So let us get the last possible default method, ie. index
$oMethod = new ReflectionMethod($this, $sDefault);
}
// We're all good to go, let's execute it
// runWithParamsInternal would automatically get the parameters of the method and populate them as required with the params
return parent::runWithParamsInternal($this, $oMethod, $params);
}
/**
* Some functions have different parameters, which are just an alias of the
* usual parameters we're getting in the url. This function just populates
* those variables so that we don't end up in an error.
*
* This is also used while rendering wrapped template
* {@link Survey_Common_Action::_renderWrappedTemplate()}
*
* @param array $params Parameters to parse and populate
* @return array Populated parameters
*/
private function _addPseudoParams($params)
{
// Return if params isn't an array
if (empty($params) || !is_array($params)) {
return $params;
}
$pseudos = array(
'id' => 'iId',
'gid' => 'iGroupId',
'qid' => 'iQuestionId',
/* Unsure we set 'iSurveyId', 'iSurveyID','surveyid' to same final survey id */
/* priority is surveyid,surveyId,sid : surveyId=1&sid=2 set sid surveyid to 1 */
'sid' => array('iSurveyId', 'iSurveyID','surveyid'), // Old link use sid
'surveyId' => array('iSurveyId', 'iSurveyID','surveyid'),// PluginHelper->sidebody : if disable surveyId usage : broke API
'surveyid' => array('iSurveyId', 'iSurveyID','surveyid'),
'srid' => 'iSurveyResponseId',
'scid' => 'iSavedControlId',
'uid' => 'iUserId',
'ugid' => 'iUserGroupId',
'fieldname' => 'sFieldName',
'fieldtext' => 'sFieldText',
'action' => 'sAction',
'lang' => 'sLanguage',
'browselang' => 'sBrowseLang',
'tokenids' => 'aTokenIds',
'tokenid' => 'iTokenId',
'subaction' => 'sSubAction',
);
// Foreach pseudo, take the key, if it exists,
// Populate the values (taken as an array) as keys in params
// with that key's value in the params
// (only if that place is empty)
foreach ($pseudos as $key => $pseudo) {
if (isset($params[$key])) {
$pseudo = (array) $pseudo;
foreach ($pseudo as $pseud) {
if (empty($params[$pseud])) {
$params[$pseud] = $params[$key];
}
}
}
}
/* Control sid,gid and qid params validity see #12434 */
// Fill param with according existing param, replace existing parameters.
// iGroupId/gid can be found with qid/iQuestionId
if(!empty($params['iQuestionId'])) {
if((string)(int)$params['iQuestionId']!==(string)$params['iQuestionId']) { // pgsql need filtering before find
throw new CHttpException(403,gT("Invalid question id"));
}
$oQuestion=Question::model()->find("qid=:qid",array(":qid"=>$params['iQuestionId']));//Move this in model to use cache
if(!$oQuestion) {
throw new CHttpException(404,gT("Question not found"));
}
if(!isset($params['iGroupId'])) {
$params['iGroupId']=$params['gid']=$oQuestion->gid;
}
}
// iSurveyId/iSurveyID/sid can be found with gid/iGroupId
if(!empty($params['iGroupId'])) {
if((string)(int)$params['iGroupId']!==(string)$params['iGroupId']) { // pgsql need filtering before find
throw new CHttpException(403,gT("Invalid group id"));
}
$oGroup=QuestionGroup::model()->find("gid=:gid",array(":gid"=>$params['iGroupId']));//Move this in model to use cache
if(!$oGroup) {
throw new CHttpException(404,gT("Group not found"));
}
if(!isset($params['iSurveyId'])) {
$params['iSurveyId']=$params['iSurveyID']=$params['surveyid']=$params['sid']=$oGroup->sid;
}
}
// Finally control validity of sid
if(!empty($params['iSurveyId'])) {
if((string)(int)$params['iSurveyId']!==(string)$params['iSurveyId']) { // pgsql need filtering before find
// 403 mean The request was valid, but the server is refusing action.
throw new CHttpException(403,gT("Invalid survey id"));
}
$oSurvey=Survey::model()->findByPk($params['iSurveyId']);
if(!$oSurvey) {
throw new CHttpException(404,gT("Survey not found"));
}
// Minimal permission needed, extra permission must be tested in each controller
if (!Permission::model()->hasSurveyPermission($params['iSurveyId'], 'survey', 'read')) {
// 403 mean (too) The user might not have the necessary permissions for a resource.
// 401 semantically means "unauthenticated"
throw new CHttpException(403);
}
$params['iSurveyId']=$params['iSurveyID']=$params['surveyid']=$params['sid']=$oSurvey->sid;
}
// Finally return the populated array
return $params;
}
/**
* Action classes require them to have a run method. We reroute it to index
* if called.
*/
public function run()
{
$this->index();
}
/**
* Routes the action into correct subaction
*
* @access protected
* @param string $sa
* @param string[] $get_vars
* @return void
*/
protected function route($sa, array $get_vars)
{
$func_args = array();
foreach ($get_vars as $k => $var)
$func_args[$k] = Yii::app()->request->getQuery($var);
return call_user_func_array(array($this, $sa), $func_args);
}
/**
* Renders template(s) wrapped in header and footer
*
* Addition of parameters should be avoided if they can be added to $aData
*
* NOTE FROM LOUIS : We want to remove this function, wich doesn't respect MVC pattern.
* The work it's doing should be handle by layout files, and subviews inside views.
* Eg : for route "admin/survey/sa/listquestiongroups/surveyid/282267"
* the Group controller should use a main layout (with admin menu bar as a widget), then render the list view, in wich the question group bar is called as a subview.
*
* So for now, we try to evacuate all the renderWrappedTemplate logic (if statements, etc.) to subfunctions, then it will be easier to remove.
* Comments starting with //// indicate how it should work in the future
*
* @param string $sAction Current action, the folder to fetch views from
* @param string|array $aViewUrls View url(s)
* @param array $aData Data to be passed on. Optional.
*/
protected function _renderWrappedTemplate($sAction = '', $aViewUrls = array(), $aData = array())
{
// Gather the data
$aData = $this->_addPseudoParams($aData); //// the check of the surveyid should be done in the Admin controller it self.
//// This will be handle by subviews inclusions
$aViewUrls = (array) $aViewUrls; $sViewPath = '/admin/';
if (!empty($sAction))
$sViewPath .= $sAction . '/';
ob_start(); //// That was used before the MVC pattern, in procedural code. Will not be used anymore.
$this->_showHeaders($aData); //// THe headers will be called from the layout
$this->_showadminmenu($aData); //// The admin menu will be called from the layout, probably as a widget for dynamic content.
$this->_userGroupBar($aData);
//// Here will start the rendering from the controller of the main view.
//// For example, the Group controller will use the main.php layout, and then render the view list_group.php
//// This view will call as a subview the questiongroupbar, and then _listquestiongroup subview.
//// This check will be useless when it will be handle directly by each specific controller.
if (!empty($aData['surveyid']))
{
$aData['oSurvey'] = Survey::model()->findByPk($aData['surveyid']);
// Needed to evaluate EM expressions in question summary
// See bug #11845
LimeExpressionManager::StartProcessingPage(false,true);
$this->_titlebar($aData);
//// Each view will call the correct bar as a subview.
$this->_surveysidemenu($aData);
$this->_surveybar($aData);
$this->_nquestiongroupbar($aData);
$this->_questionbar($aData);
$this->_browsemenubar($aData);
$this->_tokenbar($aData);
$this->_organizequestionbar($aData);
//// TODO : Move this div inside each correct view ASAP !
echo '<div class="container-fluid" id="in_survey_common"><div class="row">';
$this->_updatenotification();
$this->_notifications();
//// Here the main content views.
$this->_listquestiongroups($aData);
$this->_listquestions($aData);
$this->_nsurveysummary($aData);
}
else
{
///
$this->_fullpagebar($aData);
$this->_updatenotification();
$this->_notifications();
//// TODO : Move this div inside each correct view ASAP !
echo '
<!-- Full page, started in Survey_Common_Action::render_wrapped_template() -->
<div class="container-fluid full-page-wrapper" id="in_survey_common_action">
';
}
//// Here the rendering of all the subviews process. Will not be use anymore, because each subview will be directly called from her parent view.
//// TODO : while refactoring, we must replace the use of $aViewUrls by $aData[.. conditions ..], and then call to function such as $this->_nsurveysummary($aData);
// Load views
foreach ($aViewUrls as $sViewKey => $viewUrl)
{
if (empty($sViewKey) || !in_array($sViewKey, array('message', 'output')))
{
if (is_numeric($sViewKey))
{
Yii::app()->getController()->renderPartial($sViewPath . $viewUrl, $aData);
}
elseif (is_array($viewUrl))
{
foreach ($viewUrl as $aSubData)
{
$aSubData = array_merge($aData, $aSubData);
Yii::app()->getController()->renderPartial($sViewPath . $sViewKey, $aSubData);
}
}
}
else
{
switch ($sViewKey)
{
//// We'll use some Bootstrap alerts, and call them inside each correct view.
// Message
case 'message' :
if (empty($viewUrl['class']))
{
Yii::app()->getController()->_showMessageBox($viewUrl['title'], $viewUrl['message']);
}
else
{
Yii::app()->getController()->_showMessageBox($viewUrl['title'], $viewUrl['message'], $viewUrl['class']);
}
break;
// Output
case 'output' :
//// TODO : http://goo.gl/ABl5t5
echo $viewUrl;
if(isset($aViewUrls['afteroutput']))
echo $aViewUrls['afteroutput'];
break;
}
}
}
//// TODO : Move this div inside each correct view ASAP !
echo '</div>' ;
if (!empty($aData['surveyid']))
{
echo '</div>' ;
}
//// THe footer will be called directly from the layout.
// Footer
if(!isset($aData['display']['endscripts']) || $aData['display']['endscripts'] !== false)
Yii::app()->getController()->_loadEndScripts();
if( !Yii::app()->user->isGuest )
{
if(!isset($aData['display']['footer']) || $aData['display']['footer'] !== false)
Yii::app()->getController()->_getAdminFooter('http://manual.limesurvey.org', gT('LimeSurvey online manual'));
}
else{
echo '</body></html>';
}
$out = ob_get_contents();
ob_clean();
App()->getClientScript()->render($out);
echo $out;
}
/**
* Display the update notification
*/
protected function _updatenotification()
{
// Never use Notification model for database update.
// TODO: Real fix: No database queries while doing database update, meaning
// don't call _renderWrappedTemplate.
if (get_class($this) == 'databaseupdate') {
return;
}
if (!Yii::app()->user->isGuest && Yii::app()->getConfig('updatable')) {
$updateModel = new UpdateForm();
$updateNotification = $updateModel->updateNotification;
$urlUpdate = Yii::app()->createUrl("admin/update");
$currentVersion = Yii::app()->getConfig("buildnumber");
$superadmins = User::model()->getSuperAdmins();
if ($updateNotification->result) {
if ($updateNotification->security_update) {
UniqueNotification::broadcast(
array(
'title' => gT('Security update!')." (".gT("Current version: ")
. $currentVersion.")",
'message' => gT('A security update is available.')." <a href=".$urlUpdate.">"
. gT('Click here to use ComfortUpdate.')."</a>",
'importance' => Notification::HIGH_IMPORTANCE
),
$superadmins
);
} elseif (Yii::app()->session['unstable_update']) {
UniqueNotification::broadcast(
array(
'title' => gT('New UNSTABLE update available')." ("
. gT("Current version: ").$currentVersion.")",
'markAsNew' => false,
'message' => gT('A security update is available.')."<a href=".$urlUpdate.">"
. gT('Click here to use ComfortUpdate.')."</a>",
'importance' => Notification::HIGH_IMPORTANCE
),
$superadmins
);
} else {
UniqueNotification::broadcast(
array(
'title' => gT('New update available')." (".gT("Current version: ").$currentVersion.")",
'markAsNew' => false,
'message' => gT('A security update is available.')."<a href=".$urlUpdate.">"
. gT('Click here to use ComfortUpdate.')."</a>",
'importance' => Notification::HIGH_IMPORTANCE
),
$superadmins
);
}
}
}
}
/**
* Display notifications
*/
function _notifications()
{
$aMessage = App()->session['arrayNotificationMessages'];
unset(App()->session['arrayNotificationMessages']);
return $this->getController()->renderPartial("notifications/notifications", array('aMessage'=>$aMessage));
}
/**
* Survey summary
*/
function _nsurveysummary($aData)
{
if (isset($aData['display']['surveysummary']))
{
if ((empty($aData['display']['menu_bars']['surveysummary']) || !is_string($aData['display']['menu_bars']['surveysummary'])) && !empty($aData['gid']))
{
$aData['display']['menu_bars']['surveysummary'] = 'viewgroup';
}
$this->_surveysummary($aData);
}
}
/**
* Header
*/
function _showHeaders($aData)
{
if(!isset($aData['display']['header']) || $aData['display']['header'] !== false)
{
// Send HTTP header
header("Content-type: text/html; charset=UTF-8"); // needed for correct UTF-8 encoding
Yii::app()->getController()->_getAdminHeader();
}
}
/**
* _showadminmenu() function returns html text for the administration button bar
*
* @access public
* @global string $homedir
* @global string $scriptname
* @global string $surveyid
* @global string $setfont
* @global string $imageurl
* @global int $surveyid
* @return string $adminmenu
*/
public function _showadminmenu($aData)
{
// We don't wont the admin menu to be shown in login page
if( !Yii::app()->user->isGuest )
{
// Default password notification
if (Yii::app()->session['pw_notify'] && Yii::app()->getConfig("debug") < 2)
{
$not = new UniqueNotification(array(
'user_id' => App()->user->id,
'importance' => Notification::HIGH_IMPORTANCE,
'title' => 'Password warning',
'message' => '<span class="fa fa-exclamation-circle text-warning"></span> ' .
gT("Warning: You are still using the default password ('password'). Please change your password and re-login again.")
));
$not->save();
}
// Count active survey
$aData['dataForConfigMenu']['activesurveyscount'] = $aData['activesurveyscount'] = Survey::model()->permission(Yii::app()->user->getId())->active()->count();
// Count survey
$aData['dataForConfigMenu']['surveyscount'] = Survey::model()->count();
// Count user
$aData['dataForConfigMenu']['userscount'] = User::model()->count();
//Check if have a comfortUpdate key
if(getGlobalSetting('emailsmtpdebug')!=null)
{
$aData['dataForConfigMenu']['comfortUpdateKey'] = gT('Activated');
}
else
{
$aData['dataForConfigMenu']['comfortUpdateKey'] = gT('None');
}
$aData['sitename'] = Yii::app()->getConfig("sitename");
$updateModel = new UpdateForm();
$updateNotification = $updateModel->updateNotification;
$aData['showupdate'] = Yii::app()->getConfig('updatable') && $updateNotification->result && ! $updateNotification->unstable_update ;
// Fetch extra menus from plugins, e.g. last visited surveys
$aData['extraMenus'] = $this->fetchExtraMenus($aData);
// Get notification menu
$surveyId = isset($aData['surveyid']) ? $aData['surveyid'] : null;
Yii::import('application.controllers.admin.NotificationController');
$aData['adminNotifications'] = NotificationController::getMenuWidget($surveyId, true /* show spinner */);
$this->getController()->renderPartial("/admin/super/adminmenu", $aData);
}
}
function _titlebar($aData)
{
if( isset($aData['title_bar']) ) {
$this->getController()->renderPartial("/admin/super/title_bar", $aData);
}
}
function _tokenbar($aData)
{
if( isset($aData['token_bar']) ) {
if(isset($aData['token_bar']['closebutton']['url']))
{
$sAlternativeUrl = $aData['token_bar']['closebutton']['url'];
$aData['token_bar']['closebutton']['url'] = Yii::app()->request->getUrlReferrer( Yii::app()->createUrl($sAlternativeUrl) );
}
$this->getController()->renderPartial("/admin/token/token_bar", $aData);
}
}
/**
* Render the save/cancel bar for Organize question groups/questions
*
* @param array $aData
*
* @since 2014-09-30
* @author Olle Haerstedt
*/
function _organizequestionbar($aData)
{
if (isset($aData['organizebar']))
{
if(isset($aData['questionbar']['closebutton']['url']))
{
$sAlternativeUrl = $aData['questionbar']['closebutton']['url'];
$aData['questionbar']['closebutton']['url'] = Yii::app()->request->getUrlReferrer( Yii::app()->createUrl($sAlternativeUrl) );
}
$aData['questionbar'] = $aData['organizebar'];
$this->getController()->renderPartial("/admin/survey/Question/questionbar_view", $aData);
}
}
/**
* Shows admin menu for question
*
* @param array $aData
*/
public function _questionbar($aData)
{
if(isset($aData['questionbar'])) {
if (is_object($aData['oSurvey'])) {
$iSurveyID = $aData['surveyid'];
/** @var Survey $oSurvey */
$oSurvey = $aData['oSurvey'];
$gid = $aData['gid'];
$qid = $aData['qid'];
// action
$action = (!empty($aData['display']['menu_bars']['qid_action'])) ? $aData['display']['menu_bars']['qid_action'] : null;
$baselang = $oSurvey->language;
//Show Question Details
//Count answer-options for this question
$aData['qct'] = Answer::model()->countByAttributes(array('qid' => $qid, 'language' => $baselang));
//Count sub-questions for this question
$aData['sqct'] = Question::model()->countByAttributes(array('parent_qid' => $qid, 'language' => $baselang));
$qrrow = Question::model()->findByAttributes(array('qid' => $qid, 'gid' => $gid, 'sid' => $iSurveyID, 'language' => $baselang));
if (is_null($qrrow)) return;
$questionsummary = "<div class='menubar'>\n";
// Check if other questions in the Survey are dependent upon this question
$condarray = getQuestDepsForConditions($iSurveyID, "all", "all", $qid, "by-targqid", "outsidegroup");
$surveyinfo = $oSurvey->attributes;
$surveyinfo = array_map('flattenText', $surveyinfo);
$aData['activated'] = $surveyinfo['active'];
$qrrow = $qrrow->attributes;
$aData['languagelist'] = $oSurvey->getAllLanguages();
$aData['qtypes'] = $qtypes = getQuestionTypeList('', 'array');
$aData['action'] = $action;
$aData['surveyid'] = $iSurveyID;
$aData['qid'] = $qid;
$aData['gid'] = $gid;
$aData['qrrow'] = $qrrow;
$aData['baselang'] = $baselang;
$aAttributesWithValues = Question::model()->getAdvancedSettingsWithValues($qid, $qrrow['type'], $iSurveyID, $baselang);
$DisplayArray = array();
foreach ($aAttributesWithValues as $aAttribute)
{
if (($aAttribute['i18n'] == false && isset($aAttribute['value']) && $aAttribute['value'] != $aAttribute['default']) ||
($aAttribute['i18n'] == true && isset($aAttribute['value'][$baselang]) && $aAttribute['value'][$baselang] != $aAttribute['default']))
{
if ($aAttribute['inputtype'] == 'singleselect')
{
if(isset($aAttribute['options'][$aAttribute['value']]))
$aAttribute['value'] = $aAttribute['options'][$aAttribute['value']];
}
$DisplayArray[] = $aAttribute;
}
}
$aData['advancedsettings'] = $DisplayArray;
$aData['condarray'] = $condarray;
if(isset($aData['questionbar']['closebutton']['url']))
{
$sAlternativeUrl = $aData['questionbar']['closebutton']['url'];
$aData['questionbar']['closebutton']['url'] = Yii::app()->request->getUrlReferrer( Yii::app()->createUrl($sAlternativeUrl) );
}
$questionsummary .= $this->getController()->renderPartial('/admin/survey/Question/questionbar_view', $aData, true);
$finaldata['display'] = $questionsummary;
$this->getController()->renderPartial('/survey_view', $finaldata);
}
else
{
Yii::app()->session['flashmessage'] = gT("Invalid survey ID");
$this->getController()->redirect(array("admin/index"));
}
}
}
/**
* Show admin menu for question group view
*
* @param array $aData ?
*/
function _nquestiongroupbar($aData)
{
if(isset($aData['questiongroupbar']))
{
if(!isset($aData['gid']))
{
if(isset($_GET['gid']))
{
$aData['gid'] = $_GET['gid'];
}
}
$aData['surveyIsActive'] = $aData['oSurvey']->active !== 'N';
$surveyid = $aData['surveyid'];
$gid = $aData['gid'];
$oSurvey = $aData['oSurvey'];
$baselang =$oSurvey->language;
$aData['sumcount4'] = Question::model()->countByAttributes(array('sid' => $surveyid, 'gid' => $gid, 'language' => $baselang));
$sumresult1 = Survey::model()->with(array(
'languagesettings' => array('condition' => 'surveyls_language=language'))
)->findByPk($surveyid); //$sumquery1, 1) ; //Checked // if surveyid is invalid then die to prevent errors at a later time
$surveyinfo = $sumresult1->attributes;
$surveyinfo = array_merge($surveyinfo, $sumresult1->defaultlanguage->attributes);
$surveyinfo = array_map('flattenText', $surveyinfo);
//$surveyinfo = array_map('htmlspecialchars', $surveyinfo);
$aData['activated'] = $activated = $surveyinfo['active'];
$condarray = getGroupDepsForConditions($surveyid, "all", $gid, "by-targgid");
$aData['condarray'] = $condarray;
$aData['languagelist'] = $oSurvey->getAllLanguages();
if(isset($aData['questiongroupbar']['closebutton']['url']))
{
$sAlternativeUrl = $aData['questiongroupbar']['closebutton']['url'];
$aData['questiongroupbar']['closebutton']['url'] = Yii::app()->request->getUrlReferrer(Yii::app()->createUrl($sAlternativeUrl));
}
$this->getController()->renderPartial("/admin/survey/QuestionGroups/questiongroupbar_view", $aData);
}
}
function _fullpagebar($aData)
{
if((isset($aData['fullpagebar'])))
{
if(isset($aData['fullpagebar']['closebutton']['url']) && !isset($aData['fullpagebar']['closebutton']['url_keep']))
{
$sAlternativeUrl = '/admin/index';
$aData['fullpagebar']['closebutton']['url'] = Yii::app()->request->getUrlReferrer( Yii::app()->createUrl($sAlternativeUrl));
}
$this->getController()->renderPartial("/admin/super/fullpagebar_view", $aData);
}
}
/**
* Shows admin menu for surveys
* @param int Survey id
*/
function _surveybar($aData)
{
if((isset($aData['surveybar'])))
{
$iSurveyID = $aData['surveyid'];
$oSurvey = $aData['oSurvey'];
$gid = isset($aData['gid'])?$aData['gid']:null;
$surveyinfo = ( isset($aData['surveyinfo']) )?$aData['surveyinfo']:$oSurvey->surveyinfo;
$baselang = $surveyinfo['language'];
$activated = ($surveyinfo['active'] == 'Y');
App()->getClientScript()->registerPackage('js-cookie');
//Parse data to send to view
$aData['surveyinfo'] = $surveyinfo;
// ACTIVATE SURVEY BUTTON
$aData['activated'] = $activated;
$condition = array('sid' => $iSurveyID, 'parent_qid' => 0, 'language' => $baselang);
$sumcount3 = Question::model()->countByAttributes($condition); //Checked
$aData['canactivate'] = $sumcount3 > 0 && Permission::model()->hasSurveyPermission($iSurveyID, 'surveyactivation', 'update');
$aData['candeactivate'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveyactivation', 'update');
$aData['expired'] = $surveyinfo['expires'] != '' && ($surveyinfo['expires'] < dateShift(date("Y-m-d H:i:s"), "Y-m-d H:i", Yii::app()->getConfig('timeadjust')));
$aData['notstarted'] = ($surveyinfo['startdate'] != '') && ($surveyinfo['startdate'] > dateShift(date("Y-m-d H:i:s"), "Y-m-d H:i", Yii::app()->getConfig('timeadjust')));
// Start of suckerfish menu
// TEST BUTTON
if (!$activated)
{
$aData['icontext'] = gT("Preview survey");
}
else
{
$aData['icontext'] = gT("Execute survey");
}
$aData['baselang'] = $oSurvey->language;
$aData['additionallanguages'] = $oSurvey->getAdditionalLanguages();
$aData['languagelist'] = $oSurvey->getAllLanguages();
$aData['onelanguage']=(count($aData['languagelist'])==1);
$aData['hasadditionallanguages'] = (count($aData['additionallanguages']) > 0);
// EDIT SURVEY TEXT ELEMENTS BUTTON
$aData['surveylocale'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveylocale', 'read');
// EDIT SURVEY SETTINGS BUTTON
$aData['surveysettings'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveysettings', 'read');
// Survey permission item
$aData['surveysecurity'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveysecurity', 'read');
// CHANGE QUESTION GROUP ORDER BUTTON
$aData['surveycontentread'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'read');
$aData['groupsum'] = (getGroupSum($iSurveyID, $surveyinfo['language']) > 1);
// SET SURVEY QUOTAS BUTTON
$aData['quotas'] = Permission::model()->hasSurveyPermission($iSurveyID, 'quotas', 'read');
// Assessment menu item
$aData['assessments'] = Permission::model()->hasSurveyPermission($iSurveyID, 'assessments', 'read');
// EDIT SURVEY TEXT ELEMENTS BUTTON
// End if survey properties
// Tools menu item
// Delete survey item
$aData['surveydelete'] = Permission::model()->hasSurveyPermission($iSurveyID, 'survey', 'delete');
// Translate survey item
$aData['surveytranslate'] = Permission::model()->hasSurveyPermission($iSurveyID, 'translations', 'read');
// RESET SURVEY LOGIC BUTTON
//$sumquery6 = "SELECT count(*) FROM ".db_table_name('conditions')." as c, ".db_table_name('questions')."
// as q WHERE c.qid = q.qid AND q.sid=$iSurveyID"; //Getting a count of conditions for this survey
// TMSW Condition->Relevance: How is conditionscount used? Should Relevance do the same?
// Only show survey properties menu if at least one item is permitted
$aData['showSurveyPropertiesMenu'] =
$aData['surveylocale']
|| $aData['surveysettings']
|| $aData['surveysecurity']
|| $aData['surveycontentread']
|| $aData['quotas']
|| $aData['assessments'];
// Put menu items in tools menu
$event = new PluginEvent('beforeToolsMenuRender', $this);
$event->set('surveyId', $iSurveyID);
App()->getPluginManager()->dispatchEvent($event);
$extraToolsMenuItems = $event->get('menuItems');
$aData['extraToolsMenuItems'] = $extraToolsMenuItems;
// Add new menus in survey bar
$event = new PluginEvent('beforeSurveyBarRender', $this);
$event->set('surveyId', $iSurveyID);
App()->getPluginManager()->dispatchEvent($event);
$beforeSurveyBarRender = $event->get('menus');
$aData['beforeSurveyBarRender'] = $beforeSurveyBarRender ? $beforeSurveyBarRender : array();
// Only show tools menu if at least one item is permitted
$aData['showToolsMenu'] =
$aData['surveydelete']
|| $aData['surveytranslate']
|| Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'update')
|| !is_null($extraToolsMenuItems);
$iConditionCount = Condition::model()->with(Array('questions'=>array('condition'=>'sid ='.$iSurveyID)))->count();
$aData['surveycontent'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'update');
$aData['conditionscount'] = ($iConditionCount > 0);
// Eport menu item
$aData['surveyexport'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'export');
// PRINTABLE VERSION OF SURVEY BUTTON
// SHOW PRINTABLE AND SCANNABLE VERSION OF SURVEY BUTTON
//browse responses menu item
$aData['respstatsread'] = Permission::model()->hasSurveyPermission($iSurveyID, 'responses', 'read')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'statistics', 'read')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'responses', 'export');
// Data entry screen menu item
$aData['responsescreate'] = Permission::model()->hasSurveyPermission($iSurveyID, 'responses', 'create');
$aData['responsesread'] = Permission::model()->hasSurveyPermission($iSurveyID, 'responses', 'read');
// TOKEN MANAGEMENT BUTTON
$bTokenExists = tableExists('{{tokens_' . $iSurveyID . '}}');
if(!$bTokenExists) {
$aData['tokenmanagement'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveysettings', 'update')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'create');
}
else {
$aData['tokenmanagement'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveysettings', 'update')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'create')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'read')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'export')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'import'); // and export / import ?
}
$aData['gid'] = $gid; // = $this->input->post('gid');
if (Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'read'))
{
$aData['permission'] = true;
}
else
{
$aData['gid'] = $gid = null;
$qid = null;
$aData['permission'] = false;
}
if (getGroupListLang($gid, $baselang, $iSurveyID))
{
$aData['groups'] = getGroupListLang($gid, $baselang, $iSurveyID);
}
else
{
$aData['groups'] = "<option>" . gT("None") . "</option>";
}
$aData['GidPrev'] = $GidPrev = getGidPrevious($iSurveyID, $gid);
$aData['GidNext'] = $GidNext = getGidNext($iSurveyID, $gid);
$aData['iIconSize'] = Yii::app()->getConfig('adminthemeiconsize');
if(isset($aData['surveybar']['closebutton']['url']))
{
$sAlternativeUrl = $aData['surveybar']['closebutton']['url'];
$aData['surveybar']['closebutton']['url'] = Yii::app()->request->getUrlReferrer( Yii::app()->createUrl($sAlternativeUrl));
}
if($aData['gid']==null)
$this->getController()->renderPartial("/admin/survey/surveybar_view", $aData);
}
}
/**
* Show side menu for survey view
* @param array $aData all the needed data
*/
function _surveysidemenu($aData)
{
$iSurveyID = $aData['surveyid'];
// TODO : create subfunctions
$sumresult1 = Survey::model()->with(array(
'languagesettings' => array('condition'=>'surveyls_language=language'))
)->find('sid = :surveyid', array(':surveyid' => $aData['surveyid'])); //$sumquery1, 1) ; //Checked
if (Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'read'))
{
$aData['permission'] = true;
}
else
{
$aData['gid'] = $gid = null;
$qid = null;
$aData['permission'] = false;
}
if (!is_null($sumresult1))
{
$surveyinfo = $sumresult1->attributes;
$surveyinfo = array_merge($surveyinfo, $sumresult1->defaultlanguage->attributes);
$surveyinfo = array_map('flattenText', $surveyinfo);
$aData['activated'] = ($surveyinfo['active'] == 'Y');
// Tokens
$bTokenExists = tableExists('{{tokens_' . $iSurveyID . '}}');
if (!$bTokenExists) {
$aData['tokenmanagement'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveysettings', 'update')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'create');
}
else {
$aData['tokenmanagement'] = Permission::model()->hasSurveyPermission($iSurveyID, 'surveysettings', 'update')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'create')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'read')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'export')
|| Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'import'); // and export / import ?
}
// Question explorer
$aGroups = QuestionGroup::model()->findAllByAttributes(array('sid' => $iSurveyID, "language" => $sumresult1->defaultlanguage->surveyls_language),array('order'=>'group_order ASC'));
if(count($aGroups))
{
foreach($aGroups as $group)
{
$group->aQuestions = Question::model()->findAllByAttributes(array("sid"=>$iSurveyID, "gid"=>$group['gid'],"language"=>$sumresult1->defaultlanguage->surveyls_language), array('order'=>'question_order ASC'));
foreach($group->aQuestions as $question)
{
if(is_object($question))
{
$question->question = viewHelper::flatEllipsizeText($question->question,true,60,'[...]',0.5);
}
}
}
}
$aData['quickmenu'] = $this->renderQuickmenu($aData);
$aData['beforeSideMenuRender'] = $this->beforeSideMenuRender($aData);
$aData['aGroups'] = $aGroups;
$aData['surveycontent'] = Permission::model()->hasSurveyPermission($aData['surveyid'], 'surveycontent', 'read');
$aData['surveycontentupdate'] = Permission::model()->hasSurveyPermission($aData['surveyid'], 'surveycontent', 'update');
$aData['sideMenuBehaviour'] = getGlobalSetting('sideMenuBehaviour');
$this->getController()->renderPartial("/admin/super/sidemenu", $aData);
}
else
{
Yii::app()->session['flashmessage'] = gT("Invalid survey ID");
$this->getController()->redirect(array("admin/index"));
}
}
/**
* Render the quick-menu that is shown
* when side-menu is hidden.
*
* Only show home-icon for now.
*
* Add support for plugin to attach