1 package OpenILS::Application::Actor;
2 use base qw/OpenSRF::Application/;
3 use strict; use warnings;
6 use OpenSRF::EX qw(:try);
9 use OpenILS::Application::AppUtils;
10 use OpenILS::Utils::Fieldmapper;
11 use OpenILS::Application::Search::Actor;
13 my $apputils = "OpenILS::Application::AppUtils";
14 sub _d { warn "Patron:\n" . Dumper(shift()); }
15 my $cache_client = OpenSRF::Utils::Cache->new("global", 0);
18 __PACKAGE__->register_method(
19 method => "update_patron",
20 api_name => "open-ils.actor.patron.update",
25 my( $self, $client, $user_session, $patron ) = @_;
27 my $session = $apputils->start_db_session();
30 warn $user_session . " " . $patron . "\n";
34 OpenILS::Application::AppUtils->check_user_session(
35 $user_session ); #throws EX on error
37 # XXX does this user have permission to add/create users. Granularity?
39 # $new_patron is the patron in progress. $patron is the original patron
40 # passed in with the method. new_patron will change as the components
41 # of patron are added/updated.
46 # create/update the patron first so we can use his id
47 if($patron->isnew()) {
48 $new_patron = _add_patron(
49 $session, _clone_patron($patron));
50 if(UNIVERSAL::isa($new_patron, "OpenILS::EX")) {
51 $client->respond_complete($new_patron->ex);
56 $new_patron = $patron;
59 $new_patron = _add_update_addresses($session, $patron, $new_patron);
60 $new_patron = _add_update_cards($session, $patron, $new_patron);
62 if(UNIVERSAL::isa($new_patron,"OpenILS::EX")) {
63 $client->respond_complete($new_patron->ex);
67 $new_patron = _add_survey_responses($session, $patron, $new_patron);
68 $new_patron = _create_stat_maps($session, $user_session, $patron, $new_patron);
70 # re-update the patron if anything has happened to him during this process
71 if($new_patron->ischanged()) {
72 $new_patron = _update_patron($session, $new_patron);
74 $apputils->commit_db_session($session);
79 $err = "-*- Failure adding user: $e";
80 $apputils->rollback_db_session($session);
84 if($err) { throw OpenSRF::EX::ERROR ($err); }
87 warn "Patron Update/Create complete\n";
88 return flesh_user($new_patron->id());
92 __PACKAGE__->register_method(
93 method => "user_retrieve_fleshed_by_id",
94 api_name => "open-ils.actor.user.fleshed.retrieve",);
96 sub user_retrieve_fleshed_by_id {
97 my( $self, $client, $user_session, $user_id ) = @_;
98 my $user_obj = $apputils->check_user_session( $user_session );
99 return flesh_user($user_id);
110 $session = OpenSRF::AppSession->create("open-ils.storage");
114 # grab the user with the given card
115 my $ureq = $session->request(
116 "open-ils.storage.direct.actor.user.retrieve",
118 my $user = $ureq->gather(1);
121 my $cards_req = $session->request(
122 "open-ils.storage.direct.actor.card.search.usr",
124 $user->cards( $cards_req->gather(1) );
126 my $add_req = $session->request(
127 "open-ils.storage.direct.actor.user_address.search.usr",
129 $user->addresses( $add_req->gather(1) );
131 my $stat_req = $session->request(
132 "open-ils.storage.direct.actor.stat_cat_entry_user_map.search.target_usr",
134 $user->stat_cat_entries($stat_req->gather(1));
136 if($kill) { $session->disconnect(); }
137 $user->clear_passwd();
145 # clone and clear stuff that would break the database
149 my $new_patron = Fieldmapper::actor::user->new();
151 my $fmap = $Fieldmapper::fieldmap;
152 no strict; # shallow clone, may be useful in the fieldmapper
154 (keys %{$fmap->{"Fieldmapper::actor::user"}->{'fields'}}) {
155 $new_patron->$field( $patron->$field() );
160 $new_patron->clear_billing_address();
161 $new_patron->clear_mailing_address();
162 $new_patron->clear_addresses();
163 $new_patron->clear_card();
164 $new_patron->clear_cards();
165 $new_patron->clear_id();
166 $new_patron->clear_isnew();
167 $new_patron->clear_changed();
168 $new_patron->clear_deleted();
169 $new_patron->clear_stat_cat_entries();
179 warn "Creating new patron\n";
182 my $req = $session->request(
183 "open-ils.storage.direct.actor.user.create",$patron);
184 my $id = $req->gather(1);
186 return OpenILS::EX->new("DUPLICATE_USER_USERNAME");
189 # retrieve the patron from the db to collect defaults
190 my $ureq = $session->request(
191 "open-ils.storage.direct.actor.user.retrieve",
194 warn "Created new patron with id $id\n";
196 return $ureq->gather(1);
201 my( $session, $patron) = @_;
203 warn "updating patron " . Dumper($patron) . "\n";
205 my $req = $session->request(
206 "open-ils.storage.direct.actor.user.update",$patron );
207 my $status = $req->gather(1);
208 if(!defined($status)) {
209 throw OpenSRF::EX::ERROR
210 ("Unknown error updating patron");
216 sub _add_update_addresses {
219 my $new_patron = shift;
221 my $current_id; # id of the address before creation
223 for my $address (@{$patron->addresses()}) {
225 $address->usr($new_patron->id());
227 if(ref($address) and $address->isnew()) {
228 warn "Adding new address at street " . $address->street1() . "\n";
230 $current_id = $address->id();
231 $address = _add_address($session,$address);
233 if( $patron->billing_address() and
234 $patron->billing_address() == $current_id ) {
235 $new_patron->billing_address($address->id());
236 $new_patron->ischanged(1);
239 if( $patron->mailing_address() and
240 $patron->mailing_address() == $current_id ) {
241 $new_patron->mailing_address($address->id());
242 $new_patron->ischanged(1);
245 } elsif( ref($address) and $address->ischanged() ) {
246 warn "Updating address at street " . $address->street1();
247 $address->usr($new_patron->id());
248 _update_address($session,$address);
250 } elsif( ref($address) and $address->isdeleted() ) {
251 warn "Deleting address at street " . $address->street1();
253 if( $address->id() == $new_patron->mailing_address() ) {
254 $new_patron->clear_mailing_address();
255 _update_patron($session, $new_patron);
258 if( $address->id() == $new_patron->billing_address() ) {
259 $new_patron->clear_billing_address();
260 _update_patron($session, $new_patron);
263 _delete_address($session,$address);
271 # adds an address to the db and returns the address with new id
273 my($session, $address) = @_;
274 $address->clear_id();
276 # put the address into the database
277 my $req = $session->request(
278 "open-ils.storage.direct.actor.user_address.create",
282 my $id = $req->gather(1);
284 throw OpenSRF::EX::ERROR
285 ("Unable to create new user address");
288 warn "Created address with id $id\n";
290 # update all the necessary id's
296 sub _update_address {
297 my( $session, $address ) = @_;
298 my $req = $session->request(
299 "open-ils.storage.direct.actor.user_address.update",
301 my $status = $req->gather(1);
302 if(!defined($status)) {
303 throw OpenSRF::EX::ERROR
304 ("Unknown error updating address");
311 sub _add_update_cards {
315 my $new_patron = shift;
317 my $virtual_id; #id of the card before creation
318 for my $card (@{$patron->cards()}) {
320 $card->usr($new_patron->id());
322 if(ref($card) and $card->isnew()) {
324 $virtual_id = $card->id();
325 $card = _add_card($session,$card);
326 if(UNIVERSAL::isa($card,"OpenILS::EX")) {
330 if($patron->card() == $virtual_id) {
331 $new_patron->card($card->id());
332 $new_patron->ischanged(1);
335 } elsif( ref($card) and $card->ischanged() ) {
336 $card->usr($new_patron->id());
337 _update_card($session, $card);
344 # adds an card to the db and returns the card with new id
346 my( $session, $card ) = @_;
349 warn "Adding card with barcode " . $card->barcode() . "\n";
350 my $req = $session->request(
351 "open-ils.storage.direct.actor.card.create",
354 my $id = $req->gather(1);
356 return OpenILS::EX->new("DUPLICATE_INVALID_USER_BARCODE");
360 warn "Created patron card with id $id\n";
366 my( $session, $card ) = @_;
369 my $req = $session->request(
370 "open-ils.storage.direct.actor.card.update",
372 my $status = $req->gather(1);
373 if(!defined($status)) {
374 throw OpenSRF::EX::ERROR
375 ("Unknown error updating card");
383 sub _delete_address {
384 my( $session, $address ) = @_;
386 warn "Deleting address " . $address->street1() . "\n";
388 my $req = $session->request(
389 "open-ils.storage.direct.actor.user_address.delete",
391 my $status = $req->gather(1);
392 if(!defined($status)) {
393 throw OpenSRF::EX::ERROR
394 ("Unknown error updating address");
396 warn "Delete address status is $status\n";
401 sub _add_survey_responses {
402 my ($session, $patron, $new_patron) = @_;
404 warn "updating responses for user " . $new_patron->id . "\n";
406 my $responses = $patron->survey_responses;
407 for my $resp( @$responses ) {
408 $resp->usr($new_patron->id);
411 my $status = $apputils->simple_scalar_request(
413 "open-ils.circ.survey.submit.user_id",
420 sub _create_stat_maps {
422 my($session, $user_session, $patron, $new_patron) = @_;
424 my $maps = $patron->stat_cat_entries();
426 for my $map (@$maps) {
428 next unless($map->isnew() || $map->ischanged());
430 my $method = "open-ils.storage.direct.actor.stat_cat_entry_user_map.update";
432 $method = "open-ils.storage.direct.actor.stat_cat_entry_user_map.create";
435 $map->target_usr($new_patron->id);
437 warn "Updating stat entry with method $method and session $user_session and map $map\n";
439 my $req = $session->request($method, $map);
440 my $status = $req->gather(1);
445 throw OpenSRF::EX::ERROR
446 ("Error updating stat map with method $method");
455 __PACKAGE__->register_method(
456 method => "search_username",
457 api_name => "open-ils.actor.user.search.username",
460 sub search_username {
461 my($self, $client, $username) = @_;
462 my $users = OpenILS::Application::AppUtils->simple_scalar_request(
464 "open-ils.storage.direct.actor.user.search.usrname",
472 __PACKAGE__->register_method(
473 method => "user_retrieve_by_barcode",
474 api_name => "open-ils.actor.user.fleshed.retrieve_by_barcode",);
476 sub user_retrieve_by_barcode {
477 my($self, $client, $user_session, $barcode) = @_;
478 warn "Searching for user with barcode $barcode\n";
479 my $user_obj = $apputils->check_user_session( $user_session );
481 my $session = OpenSRF::AppSession->create("open-ils.storage");
483 # find the card with the given barcode
484 my $creq = $session->request(
485 "open-ils.storage.direct.actor.card.search.barcode",
487 my $card = $creq->gather(1);
489 my $user = flesh_user($card->usr(), $session);
490 $session->disconnect();
497 __PACKAGE__->register_method(
498 method => "get_user_by_id",
499 api_name => "open-ils.actor.user.retrieve",);
502 my ($self, $client, $user_session, $id) = @_;
504 my $user_obj = $apputils->check_user_session( $user_session );
506 return $apputils->simple_scalar_request(
508 "open-ils.storage.direct.actor.user.retrieve",
514 __PACKAGE__->register_method(
515 method => "get_org_types",
516 api_name => "open-ils.actor.org_types.retrieve",);
520 my($self, $client) = @_;
522 return $org_types if $org_types;
524 $apputils->simple_scalar_request(
526 "open-ils.storage.direct.actor.org_unit_type.retrieve.all.atomic" );
531 __PACKAGE__->register_method(
532 method => "get_user_profiles",
533 api_name => "open-ils.actor.user.profiles.retrieve",
537 sub get_user_profiles {
538 return $user_profiles if $user_profiles;
540 return $user_profiles =
541 $apputils->simple_scalar_request(
543 "open-ils.storage.direct.actor.profile.retrieve.all.atomic");
548 __PACKAGE__->register_method(
549 method => "get_user_ident_types",
550 api_name => "open-ils.actor.user.ident_types.retrieve",
553 sub get_user_ident_types {
554 return $ident_types if $ident_types;
555 return $ident_types =
556 $apputils->simple_scalar_request(
558 "open-ils.storage.direct.config.identification_type.retrieve.all.atomic" );
564 __PACKAGE__->register_method(
565 method => "get_org_unit",
566 api_name => "open-ils.actor.org_unit.retrieve",
571 my( $self, $client, $user_session ) = @_;
574 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
576 my $home_ou = OpenILS::Application::AppUtils->simple_scalar_request(
578 "open-ils.storage.direct.actor.org_unit.retrieve",
579 $user_obj->home_ou );
587 __PACKAGE__->register_method(
588 method => "get_org_tree",
589 api_name => "open-ils.actor.org_tree.retrieve",
591 note => "Returns the entire org tree structure",
595 my( $self, $client) = @_;
597 # see if it's in the cache
598 warn "Getting ORG Tree\n";
599 my $tree = $cache_client->get_cache('orgtree');
601 warn "Found orgtree in cache. returning...\n";
605 my $orglist = $apputils->simple_scalar_request(
607 "open-ils.storage.direct.actor.org_unit.retrieve.all.atomic" );
609 $tree = $self->build_org_tree($orglist);
610 $cache_client->put_cache('orgtree', $tree);
616 # turns an org list into an org tree
619 my( $self, $orglist) = @_;
621 return $orglist unless (
622 ref($orglist) and @$orglist > 1 );
625 $a->ou_type <=> $b->ou_type ||
626 $a->name cmp $b->name } @$orglist;
628 for my $org (@list) {
630 next unless ($org and defined($org->parent_ou));
631 my ($parent) = grep { $_->id == $org->parent_ou } @list;
634 $parent->children([]) unless defined($parent->children);
635 push( @{$parent->children}, $org );
643 __PACKAGE__->register_method(
644 method => "get_org_descendants",
645 api_name => "open-ils.actor.org_tree.descendants.retrieve"
648 # depth is optional. org_unit is the id
649 sub get_org_descendants {
650 my( $self, $client, $org_unit, $depth ) = @_;
651 my $orglist = $apputils->simple_scalar_request(
653 "open-ils.storage.actor.org_unit.descendants.atomic",
655 return $self->build_org_tree($orglist);
659 __PACKAGE__->register_method(
660 method => "get_org_ancestors",
661 api_name => "open-ils.actor.org_tree.ancestors.retrieve"
664 # depth is optional. org_unit is the id
665 sub get_org_ancestors {
666 my( $self, $client, $org_unit, $depth ) = @_;
667 my $orglist = $apputils->simple_scalar_request(
669 "open-ils.storage.actor.org_unit.ancestors.atomic",
671 return $self->build_org_tree($orglist);
675 __PACKAGE__->register_method(
676 method => "get_standings",
677 api_name => "open-ils.actor.standings.retrieve"
682 return $user_standings if $user_standings;
683 return $user_standings =
684 $apputils->simple_scalar_request(
686 "open-ils.storage.direct.config.standing.retrieve.all.atomic" );
691 __PACKAGE__->register_method(
692 method => "get_my_org_path",
693 api_name => "open-ils.actor.org_unit.full_path.retrieve"
696 sub get_my_org_path {
697 my( $self, $client, $user_session, $org_id ) = @_;
698 my $user_obj = $apputils->check_user_session($user_session);
699 if(!defined($org_id)) { $org_id = $user_obj->home_ou; }
701 return $apputils->simple_scalar_request(
703 "open-ils.storage.actor.org_unit.full_path.atomic",
708 __PACKAGE__->register_method(
709 method => "patron_adv_search",
710 api_name => "open-ils.actor.patron.search.advanced" );
712 sub patron_adv_search {
713 my( $self, $client, $staff_login, $search_hash ) = @_;
716 warn "patron adv with $staff_login and search " .
717 Dumper($search_hash) . "\n";
719 my $session = OpenSRF::AppSession->create("open-ils.storage");
720 my $req = $session->request(
721 "open-ils.storage.actor.user.crazy_search", $search_hash);
723 my $ans = $req->gather(1);
724 $session->disconnect();
744 some old methods that may be good to keep around for now
747 my( $session, $card ) = @_;
749 warn "Deleting card with barcode " . $card->barcode() . "\n";
750 my $req = $session->request(
751 "open-ils.storage.direct.actor.card.delete",
753 my $status = $req->gather(1);
754 if(!defined($status)) {
755 throw OpenSRF::EX::ERROR
756 ("Unknown error updating card");
762 # deletes the patron and any attached addresses and cards
763 __PACKAGE__->register_method(
764 method => "delete_patron",
765 api_name => "open-ils.actor.patron.delete",
770 my( $self, $client, $patron ) = @_;
771 my $session = $apputils->start_db_session();
776 $patron->clear_mailing_address();
777 $patron->clear_billing_address();
778 $patron->ischanged(1);
780 _update_patron($session, $patron);
781 _delete_address($session,$_) for (@{$patron->addresses()});
782 _delete_card($session,$_) for (@{$patron->cards()});
783 _delete_patron($session,$patron);
784 $apputils->commit_db_session($session);
788 $err = "-*- Failure deleting user: $e";
789 $apputils->rollback_db_session($session);
793 if($err) { throw OpenSRF::EX::ERROR ($err); }
794 warn "Patron Delete complete\n";
799 my( $session, $patron ) = @_;
801 warn "Deleting patron " . $patron->usrname() . "\n";
803 my $req = $session->request(
804 "open-ils.storage.direct.actor.user.delete",
806 my $status = $req->gather(1);
807 if(!defined($status)) {
808 throw OpenSRF::EX::ERROR
809 ("Unknown error updating patron");