oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Survey cleanup and minor bug fixes

Browse source 
Cleaned up edit page tabs
Improved API docs
Added noCreate option to responseId so that it doesn't create unnecessary responses
Added groupToTakeSurvey priv check to takeSurvey
This commit is contained in:
Patrick Donelan 2009-06-09 03:27:06 +00:00
parent 977be654cc
commit 9004e5d711
3 changed files with 137 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

224
lib/WebGUI/Asset/Wobject/Survey.pm
View file

@ -49,27 +49,13 @@ sub definition {
my %properties;
tie %properties, 'Tie::IxHash'; ## no critic
%properties = (
templateId => {
fieldType => 'template',
defaultValue => 'PBtmpl0000000000000061',
tab => 'display',
namespace => 'Survey',
label => $i18n->get('survey template'),
hoverHelp => $i18n->get('survey template help'),
},
showProgress => {
fieldType => 'yesNo',
defaultValue => 0,
# Properties Tab
exitURL => {
fieldType => 'text',
defaultValue => undef,
tab => 'properties',
label => $i18n->get('Show user their progress'),
hoverHelp => $i18n->get('Show user their progress help'),
},
showTimeLimit => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'properties',
label => $i18n->get('Show user their time remaining'),
hoverHelp => $i18n->get('Show user their time remaining'),
label => $i18n->get('Survey Exit URL'),
hoverHelp => $i18n->get('Survey Exit URL help'),
},
timeLimit => {
fieldType => 'integer',
@ -89,35 +75,31 @@ sub definition {
'restartSurvey' => $i18n->get('restart survey label'),
},
},
groupToEditSurvey => {
fieldType => 'group',
defaultValue => 4,
label => $i18n->get('Group to edit survey'),
hoverHelp => $i18n->get('Group to edit survey help'),
},
groupToTakeSurvey => {
fieldType => 'group',
defaultValue => 2,
label => $i18n->get('Group to take survey'),
hoverHelp => $i18n->get('Group to take survey help'),
},
groupToViewReports => {
fieldType => 'group',
defaultValue => 4,
label => $i18n->get('Group to view reports'),
hoverHelp => $i18n->get('Group to view reports help'),
},
exitURL => {
fieldType => 'text',
onSurveyEndWorkflowId => {
tab => 'properties',
defaultValue => undef,
label => $i18n->get('Survey Exit URL'),
hoverHelp => $i18n->get('Survey Exit URL help'),
type => 'WebGUI::Asset::Wobject::Survey',
fieldType => 'workflow',
label => 'Survey End Workflow',
hoverHelp => 'Workflow to run when user completes the Survey',
none => 1,
},
maxResponsesPerUser => {
fieldType => 'integer',
defaultValue => 1,
label => $i18n->get('Max user responses'),
hoverHelp => $i18n->get('Max user responses help'),
allowBackBtn => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'properties',
label => $i18n->get('Allow back button'),
hoverHelp => $i18n->get('Allow back button help'),
},
# Display Tab
templateId => {
fieldType => 'template',
defaultValue => 'PBtmpl0000000000000061',
tab => 'display',
namespace => 'Survey',
label => $i18n->get('survey template'),
hoverHelp => $i18n->get('survey template help'),
},
surveySummaryTemplateId => {
tab => 'display',
@ -207,35 +189,65 @@ sub definition {
defaultValue => 'S3zpVitAmhy58CAioH359Q',
namespace => 'Survey/TestResults',
},
showProgress => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'display',
label => $i18n->get('Show user their progress'),
hoverHelp => $i18n->get('Show user their progress help'),
},
showTimeLimit => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'display',
label => $i18n->get('Show user their time remaining'),
hoverHelp => $i18n->get('Show user their time remaining'),
},
quizModeSummary => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'display',
label => $i18n->get('Quiz mode summaries'),
hoverHelp => $i18n->get('Quiz mode summaries help'),
},
# Security Tab
groupToEditSurvey => {
fieldType => 'group',
tab => 'security',
defaultValue => 4,
label => $i18n->get('Group to edit survey'),
hoverHelp => $i18n->get('Group to edit survey help'),
},
groupToTakeSurvey => {
fieldType => 'group',
tab => 'security',
defaultValue => 2,
label => $i18n->get('Group to take survey'),
hoverHelp => $i18n->get('Group to take survey help'),
},
groupToViewReports => {
fieldType => 'group',
tab => 'security',
defaultValue => 4,
label => $i18n->get('Group to view reports'),
hoverHelp => $i18n->get('Group to view reports help'),
},
maxResponsesPerUser => {
fieldType => 'integer',
tab => 'security',
defaultValue => 1,
label => $i18n->get('Max user responses'),
hoverHelp => $i18n->get('Max user responses help'),
},
# Other
surveyJSON => {
fieldType => 'text',
defaultValue => '',
autoGenerate => 0,
noFormPost => 1,
},
onSurveyEndWorkflowId => {
tab => 'properties',
defaultValue => undef,
type => 'WebGUI::Asset::Wobject::Survey',
fieldType => 'workflow',
label => 'Survey End Workflow',
hoverHelp => 'Workflow to run when user completes the Survey',
none => 1,
},
quizModeSummary => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'properties',
label => $i18n->get('Quiz mode summaries'),
hoverHelp => $i18n->get('Quiz mode summaries help'),
},
allowBackBtn => {
fieldType => 'yesNo',
defaultValue => 0,
tab => 'properties',
label => $i18n->get('Allow back button'),
hoverHelp => $i18n->get('Allow back button help'),
},
);
push @{$definition}, {
@ -1280,7 +1292,7 @@ sub getMenuVars {
view_transposed_results_url => $self->getUrl('func=exportTransposedResults'),
view_statistical_overview_url => $self->getUrl('func=viewStatisticalOverview'),
view_grade_book_url => $self->getUrl('func=viewGradeBook'),
user_canTakeSurvey => $self->session->user->isInGroup( $self->get('groupToTakeSurvey') ),
user_canTakeSurvey => $self->canTakeSurvey,
user_canViewReports => $self->session->user->isInGroup( $self->get('groupToViewReports') ),
user_canEditSurvey => $self->session->user->isInGroup( $self->get('groupToEditSurvey') ),
};
@ -1306,6 +1318,10 @@ A specific userId to use. Defaults to the current user
A template to use. Defaults to this Survey's feedbackTemplateId
=head4 isComplete
A value of isComplete to filter against (defaults to isComplete > 0)
=cut
sub getResponseDetails {
@ -1424,6 +1440,11 @@ Survey questions are loaded asynchronously via javascript calls to L<"www_loadQu
sub www_takeSurvey {
my $self = shift;
if ( !$self->canTakeSurvey() ) {
$self->session->log->debug('canTakeSurvey false');
return;
}
my $out = $self->processTemplate( {}, $self->get('surveyTakeTemplateId') );
return $self->processStyle($out);
}
@ -1695,7 +1716,7 @@ sub surveyEnd {
my %opts = validate(@_, { timeout => 0, restart => 0, exitUrl => 0 });
# If an in-progress response exists, mark it as complete
if ( my $responseId = $self->responseId ) {
if ( my $responseId = $self->responseId( { noCreate => 1 } ) ) {
# Decide if we should flag any special actions such as restart or timeout
my $restart = $opts{restart};
my $timeoutRestart = $opts{timeout} && $self->get('doAfterTimeLimit') eq 'restartSurvey';
@ -1877,7 +1898,8 @@ Turns the response object into JSON and saves it to the DB.
sub persistResponseJSON {
my $self = shift;
my $data = $self->responseJSON->freeze();
$self->session->db->write( 'update Survey_response set responseJSON = ? where Survey_responseId = ?', [ $data, $self->responseId ] );
$self->session->db->write( 'update Survey_response set responseJSON = ? where Survey_responseId = ?',
[ $data, $self->responseId( { noCreate => 1 } ) ] );
return;
}
@ -1890,27 +1912,49 @@ L<WebGUI::Asset::Wobject::Survey::ResponseJSON> instance. See also L<"responseJS
The responseId of the current user is returned, or created if one does not already exist.
=head3 userId (optional)
=head3 options
If specified, this user is used rather than the current user
The following options are supported:
=head4 userId (optional)
If specified, this user is used rather than the current user
=head4 isComplete
A value of isComplete to filter against (defaults to isComplete = 0)
=head4 noCreate
If a responseId does not already exist, do not create one (default is to create an new responseId)
=cut
sub responseId {
my $self = shift;
my ($userId) = validate_pos(@_, {type => SCALAR, optional => 1});
$userId ||= $self->session->user->userId;
my $user = WebGUI::User->new($self->session, $userId);
my $ip = $self->session->env->getIp;
my $responseId = $self->{responseId};
# If a cached responseId doesn't exist, get the current in-progress response from the db
$responseId ||= $self->session->db->quickScalar(
"select Survey_responseId from Survey_response where userId = ? and assetId = ? and isComplete = 0",
[ $userId, $self->getId ] );
my $self = shift;
my %opts = validate( @_, { userId => 0, isComplete => 0, noCreate => 0 } );
my $userId = $opts{userId} || $self->session->user->userId;
my $isComplete = $opts{isComplete};
my $noCreate = $opts{noCreate};
my $user = WebGUI::User->new( $self->session, $userId );
my $ip = $self->session->env->getIp;
my $responseId = $self->{responseId};
# If a cached responseId doesn't exist, get the current in-progress response from the db
# By default, get current response (e.g. isComplete = 0)
my $isCompleteClause = defined $isComplete ? "isComplete = $isComplete" : 'isComplete = 0';
$responseId ||= $self->session->db->quickScalar(
"select Survey_responseId from Survey_response where userId = ? and assetId = ? and $isCompleteClause order by endDate desc limit 1",
[ $userId, $self->getId ]
);
if ( !$responseId && $noCreate ) {
$self->session->log->debug("ResponseId doesn't exist, but we were asked not to create a new one");
return;
}
# If no current in-progress response exists, create one (as long as we're allowed to)
if ( !$responseId ) {
my $maxResponsesPerUser = $self->get('maxResponsesPerUser');
@ -1934,6 +1978,8 @@ sub responseId {
# Store the newly created responseId
$self->{responseId} = $responseId;
$self->session->log->debug("Created new Survey response: $responseId for user: $userId for Survey: " . $self->getId);
# Manually persist ResponseJSON since we have changed $self->responseId
$self->persistResponseJSON();
}
@ -2790,7 +2836,7 @@ sub www_runTests {
# Manage response ourselves rather than doing it over and over per-test
$self->session->db->write( 'delete from Survey_response where assetId = ? and userId = ?',
[ $self->getId, $self->session->user->userId() ] );
my $responseId = $self->responseId($self->session->user->userId)
my $responseId = $self->responseId( { userId => $self->session->user->userId } )
or return $self->www_editTestSuite('Unable to start survey response');
# Also initSurveyOrder ourselves once, and then preserve, rather than re-loading

2
lib/WebGUI/Asset/Wobject/Survey/Test.pm
View file

@ -139,7 +139,7 @@ sub run {
[ $self->getId, $self->session->user->userId() ] );
# Start a response as current user
$responseId = $survey->responseId($self->session->user->userId)
$responseId = $survey->responseId( { userId => $self->session->user->userId } )
or return { tap => "Bail Out! Unable to start survey response" };
}

2
t/Asset/Wobject/Survey/ExpressionEngine.t
View file

@ -214,7 +214,7 @@ SKIP: {
$survey->surveyJSON->answer([0,1,0])->{recordedAnswer} = 'ext_s0q1a0';
$survey->surveyJSON->answer([0,1,0])->{value} = 50; # worth 50 points
my $responseId = $survey->responseId($user->userId);
my $responseId = $survey->responseId( { userId => $user->userId } );
my $rJSON = $survey->responseJSON(undef, $responseId);
$rJSON->recordResponses({