1 # ---------------------------------------------------------------
2 # Copyright (C) 2005 Georgia Public Library Service
3 # Bill Erickson <highfalutin@gmail.com>
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 # ---------------------------------------------------------------
16 package OpenILS::Application::Circ::Survey;
17 use base qw/OpenILS::Application/;
18 use strict; use warnings;
19 use OpenSRF::EX qw/:try/;
20 use OpenILS::Application::AppUtils;
23 use Time::HiRes qw(time);
24 use OpenILS::Utils::CStoreEditor qw/:funcs/;
26 my $apputils = "OpenILS::Application::AppUtils";
28 # - creates a new survey
29 # expects a survey complete with questions and answers
30 __PACKAGE__->register_method(
31 method => "add_survey",
32 api_name => "open-ils.circ.survey.create");
35 my( $self, $client, $user_session, $survey ) = @_;
37 my($user_obj, $evt) = $apputils->checkses($user_session);
40 my $session = $apputils->start_db_session();
41 my $err = undef; my $id;
46 $survey = _add_survey($session, $survey);
47 _add_questions($session, $survey);
48 $apputils->commit_db_session($session);
52 $err = "Error creating survey: $e\n";
53 $apputils->rollback_db_session($session);
56 if($err) { throw OpenSRF::EX::ERROR ($err); }
58 # re-retrieve the survey from the db and return it
59 return get_fleshed_survey($self, $client, $survey->id() );
64 my($session, $survey) = @_;
65 my $req = $session->request(
66 "open-ils.storage.direct.action.survey.create",
69 my $id = $req->gather(1);
72 throw OpenSRF::EX::ERROR
73 ("Unable to create new survey " . $survey->name());
81 my($session, $survey) = @_;
85 my($session, $survey) = @_;
87 # create new questions in the db
88 if( $survey->questions() ) {
89 for my $question (@{$survey->questions()}){
91 $question->survey($survey->id());
92 my $virtual_id = $question->id();
93 $question->clear_id();
96 my $req = $session->request(
97 'open-ils.storage.direct.action.survey_question.create',
99 my $new_id = $req->gather(1);
102 throw OpenSRF::EX::ERROR
103 ("Error creating new survey question " . $question->question() . "\n")
106 # now update the responses to this question
107 if($question->answers()) {
108 for my $answer (@{$question->answers()}) {
109 $answer->question($new_id);
110 _add_answer($session,$answer);
119 my($session, $answer) = @_;
121 my $req = $session->request(
122 "open-ils.storage.direct.action.survey_answer.create",
124 my $id = $req->gather(1);
126 throw OpenSRF::EX::ERROR
127 ("Error creating survey answer " . $answer->answer() );
134 # retrieve surveys for a specific org subtree.
135 __PACKAGE__->register_method(
136 method => "get_required_surveys",
137 api_name => "open-ils.circ.survey.retrieve.required");
139 sub get_required_surveys {
140 my( $self, $client, $user_session ) = @_;
143 my ($user_obj, $evt) = $apputils->checkses($user_session);
146 my $orgid = $user_obj->ws_ou() ? $user_obj->ws_ou() : $user_obj->home_ou();
147 my $surveys = $apputils->simple_scalar_request(
149 "open-ils.storage.action.survey.required.atomic",
153 for my $survey (@$surveys) {
154 push(@fleshed, get_fleshed_survey($self, $client, $survey));
160 __PACKAGE__->register_method(
161 method => "get_survey_responses",
162 api_name => "open-ils.circ.survey.response.retrieve");
164 sub get_survey_responses {
165 my( $self, $client, $user_session, $survey_id, $user_id ) = @_;
168 my ($user_obj, $evt) = $apputils->checkses($user_session);
170 $user_id = $user_obj->id;
173 my $res = $apputils->simple_scalar_request(
175 "open-ils.cstore.direct.action.survey_response.search.atomic",
176 { usr => $user_id, survey => $survey_id } );
178 if( $res && ref($res) and $res->[0]) {
179 return [ sort { $a->id() <=> $b->id() } @$res ];
185 __PACKAGE__->register_method(
186 method => "get_all_surveys",
187 api_name => "open-ils.circ.survey.retrieve.all");
189 sub get_all_surveys {
190 my( $self, $client, $user_session ) = @_;
192 my ($user_obj, $evt) = $apputils->checkses($user_session);
195 my $orgid = $user_obj->ws_ou() ? $user_obj->ws_ou() : $user_obj->home_ou();
196 my $surveys = $apputils->simple_scalar_request(
198 "open-ils.storage.action.survey.all.atomic",
202 for my $survey (@$surveys) {
203 push(@fleshed, get_fleshed_survey($self, $client, $survey));
211 __PACKAGE__->register_method(
212 method => "get_fleshed_survey",
213 api_name => "open-ils.circ.survey.fleshed.retrieve");
215 sub get_fleshed_survey {
216 my( $self, $client, $survey_id ) = @_;
218 my $session = OpenSRF::AppSession->create("open-ils.storage");
221 if( ref($survey_id) and
222 (ref($survey_id) =~ /^Fieldmapper/)) {
223 $survey = $survey_id;
227 my $sreq = $session->request(
228 "open-ils.storage.direct.action.survey.retrieve",
230 $survey = $sreq->gather(1);
231 if(! $survey) { return undef; }
234 $survey->questions([]);
237 my $qreq = $session->request(
238 "open-ils.storage.direct.action.survey_question.search.survey.atomic",
241 my $questions = $qreq->gather(1);
245 for my $question (@$questions) {
246 next unless defined $question;
248 # add this question to the survey
249 push( @{$survey->questions()}, $question );
252 my $ans_req = $session->request(
253 "open-ils.storage.direct.action.survey_answer.search.question.atomic",
256 # add this array of answers to this question
257 $question->answers( $ans_req->gather(1) );
262 $session->disconnect();
269 __PACKAGE__->register_method(
270 method => "submit_survey",
271 api_name => "open-ils.circ.survey.submit.session");
273 __PACKAGE__->register_method(
274 method => "submit_survey",
275 api_name => "open-ils.circ.survey.submit.user_id");
277 __PACKAGE__->register_method(
278 method => "submit_survey",
279 api_name => "open-ils.circ.survey.submit.anon");
283 my( $self, $client, $responses ) = @_;
286 throw OpenSRF::EX::ERROR
287 ("No survey object sent in update");
291 if(!ref($responses)) { $responses = [$responses]; }
293 my $session = $apputils->start_db_session();
295 my $group_id = $session->request(
296 "open-ils.storage.action.survey_response.next_group_id")->gather(1);
299 for my $res (@$responses) {
303 if($self->api_name =~ /session/) {
304 if( ! ($id = $already_seen{$res->usr}) ) {
305 my ($user_obj, $evt) = $apputils->checkses($res->usr);
308 $already_seen{$res->usr} = $id;
311 } elsif( $self->api_name =~ /anon/ ) {
315 $res->response_group_id($group_id);
316 my $req = $session->request(
317 "open-ils.storage.direct.action.survey_response.create",
319 my $newid = $req->gather(1);
322 throw OpenSRF::EX::ERROR
323 ("Error creating new survey response");
327 $apputils->commit_db_session($session);
333 __PACKAGE__->register_method(
334 method => "get_random_survey",
335 api_name => "open-ils.circ.survey.retrieve.opac.random");
337 sub get_random_survey {
338 my( $self, $client, $user_session ) = @_;
340 my ($user_obj, $evt) = $apputils->checkses($user_session);
343 my $surveys = $apputils->simple_scalar_request(
345 "open-ils.storage.action.survey.opac.atomic",
346 $user_obj->home_ou() );
348 my $random = int(rand(scalar(@$surveys)));
349 my $surv = $surveys->[$random];
351 return get_fleshed_survey($self, $client, $surv);
355 __PACKAGE__->register_method(
356 method => "get_random_survey_global",
357 api_name => "open-ils.circ.survey.retrieve.opac.random.global");
359 sub get_random_survey_global {
360 my( $self, $client ) = @_;
362 my $surveys = $apputils->simple_scalar_request(
364 "open-ils.storage.direct.action.survey.search.atomic",
365 # XXX grab the org tree to get the root id...
366 { owner => 1, opac => 't' } );
368 my $random = int(rand(scalar(@$surveys)));
369 my $surv = $surveys->[$random];
371 return get_fleshed_survey($self, $client, $surv);
376 __PACKAGE__->register_method (
377 method => 'delete_survey',
378 api_name => 'open-ils.circ.survey.delete.cascade'
380 __PACKAGE__->register_method (
381 method => 'delete_survey',
382 api_name => 'open-ils.circ.survey.delete.cascade.override'
386 my($self, $conn, $auth, $survey_id) = @_;
387 my $e = new_editor(authtoken => $auth, xact => 1);
388 return $e->die_event unless $e->checkauth;
390 my $survey = $e->retrieve_action_survey($survey_id)
391 or return $e->die_event;
392 return $e->die_event unless $e->allowed('ADMIN_SURVEY', $survey->owner);
394 my $questions = $e->search_action_survey_question({survey => $survey_id});
396 push(@answers, @{$e->search_action_survey_answer({question => $_->id})}) for @$questions;
397 my $responses = $e->search_action_survey_response({survey => $survey_id});
399 return OpenILS::Event->new('SURVEY_RESPONSES_EXIST')
400 if @$responses and $self->api_name =! /override/;
402 for my $resp (@$responses) {
403 $e->delete_action_survey_response($resp) or return $e->die_event;
406 for my $ans (@answers) {
407 $e->delete_action_survey_answer($ans) or return $e->die_event;
410 for my $quest (@$questions) {
411 $e->delete_action_survey_question($quest) or return $e->die_event;
414 $e->delete_action_survey($survey) or return $e->die_event;