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");
188 warn "Created new patron with id $id\n";
190 # retrieve the patron from the db to collect defaults
191 my $ureq = $session->request(
192 "open-ils.storage.direct.actor.user.retrieve",
194 return $ureq->gather(1);
199 my( $session, $patron) = @_;
201 warn "updating patron " . Dumper($patron) . "\n";
203 my $req = $session->request(
204 "open-ils.storage.direct.actor.user.update",$patron );
205 my $status = $req->gather(1);
206 if(!defined($status)) {
207 throw OpenSRF::EX::ERROR
208 ("Unknown error updating patron");
214 sub _add_update_addresses {
217 my $new_patron = shift;
219 my $current_id; # id of the address before creation
221 for my $address (@{$patron->addresses()}) {
223 $address->usr($new_patron->id());
225 if(ref($address) and $address->isnew()) {
226 warn "Adding new address at street " . $address->street1() . "\n";
228 $current_id = $address->id();
229 $address = _add_address($session,$address);
231 if( $patron->billing_address() and
232 $patron->billing_address() == $current_id ) {
233 $new_patron->billing_address($address->id());
234 $new_patron->ischanged(1);
237 if( $patron->mailing_address() and
238 $patron->mailing_address() == $current_id ) {
239 $new_patron->mailing_address($address->id());
240 $new_patron->ischanged(1);
243 } elsif( ref($address) and $address->ischanged() ) {
244 warn "Updating address at street " . $address->street1();
245 $address->usr($new_patron->id());
246 _update_address($session,$address);
248 } elsif( ref($address) and $address->isdeleted() ) {
249 warn "Deleting address at street " . $address->street1();
251 if( $address->id() == $new_patron->mailing_address() ) {
252 $new_patron->clear_mailing_address();
253 _update_patron($session, $new_patron);
256 if( $address->id() == $new_patron->billing_address() ) {
257 $new_patron->clear_billing_address();
258 _update_patron($session, $new_patron);
261 _delete_address($session,$address);
269 # adds an address to the db and returns the address with new id
271 my($session, $address) = @_;
272 $address->clear_id();
274 # put the address into the database
275 my $req = $session->request(
276 "open-ils.storage.direct.actor.user_address.create",
280 my $id = $req->gather(1);
282 throw OpenSRF::EX::ERROR
283 ("Unable to create new user address");
286 warn "Created address with id $id\n";
288 # update all the necessary id's
294 sub _update_address {
295 my( $session, $address ) = @_;
296 my $req = $session->request(
297 "open-ils.storage.direct.actor.user_address.update",
299 my $status = $req->gather(1);
300 if(!defined($status)) {
301 throw OpenSRF::EX::ERROR
302 ("Unknown error updating address");
309 sub _add_update_cards {
313 my $new_patron = shift;
315 my $virtual_id; #id of the card before creation
316 for my $card (@{$patron->cards()}) {
318 $card->usr($new_patron->id());
320 if(ref($card) and $card->isnew()) {
322 $virtual_id = $card->id();
323 $card = _add_card($session,$card);
324 if(UNIVERSAL::isa($card,"OpenILS::EX")) {
328 if($patron->card() == $virtual_id) {
329 $new_patron->card($card->id());
330 $new_patron->ischanged(1);
333 } elsif( ref($card) and $card->ischanged() ) {
334 $card->usr($new_patron->id());
335 _update_card($session, $card);
342 # adds an card to the db and returns the card with new id
344 my( $session, $card ) = @_;
347 warn "Adding card with barcode " . $card->barcode() . "\n";
348 my $req = $session->request(
349 "open-ils.storage.direct.actor.card.create",
352 my $id = $req->gather(1);
354 return OpenILS::EX->new("DUPLICATE_INVALID_USER_BARCODE");
358 warn "Created patron card with id $id\n";
364 my( $session, $card ) = @_;
367 my $req = $session->request(
368 "open-ils.storage.direct.actor.card.update",
370 my $status = $req->gather(1);
371 if(!defined($status)) {
372 throw OpenSRF::EX::ERROR
373 ("Unknown error updating card");
381 sub _delete_address {
382 my( $session, $address ) = @_;
384 warn "Deleting address " . $address->street1() . "\n";
386 my $req = $session->request(
387 "open-ils.storage.direct.actor.user_address.delete",
389 my $status = $req->gather(1);
390 if(!defined($status)) {
391 throw OpenSRF::EX::ERROR
392 ("Unknown error updating address");
394 warn "Delete address status is $status\n";
399 sub _add_survey_responses {
400 my ($session, $patron, $new_patron) = @_;
402 warn "updating responses for user " . $new_patron->id . "\n";
404 my $responses = $patron->survey_responses;
405 for my $resp( @$responses ) {
406 $resp->usr($new_patron->id);
409 my $status = $apputils->simple_scalar_request(
411 "open-ils.circ.survey.submit.user_id",
418 sub _create_stat_maps {
420 my($session, $user_session, $patron, $new_patron) = @_;
422 my $maps = $patron->stat_cat_entries();
424 for my $map (@$maps) {
426 next unless($map->isnew() || $map->ischanged());
428 my $method = "open-ils.storage.direct.actor.stat_cat_entry_user_map.update";
430 $method = "open-ils.storage.direct.actor.stat_cat_entry_user_map.create";
433 $map->target_usr($new_patron->id);
435 warn "Updating stat entry with method $method and session $user_session and map $map\n";
437 my $req = $session->request($method, $map);
438 my $status = $req->gather(1);
443 throw OpenSRF::EX::ERROR
444 ("Error updating stat map with method $method");
453 __PACKAGE__->register_method(
454 method => "search_username",
455 api_name => "open-ils.actor.user.search.username",
458 sub search_username {
459 my($self, $client, $username) = @_;
460 my $users = OpenILS::Application::AppUtils->simple_scalar_request(
462 "open-ils.storage.direct.actor.user.search.usrname",
470 __PACKAGE__->register_method(
471 method => "user_retrieve_by_barcode",
472 api_name => "open-ils.actor.user.fleshed.retrieve_by_barcode",);
474 sub user_retrieve_by_barcode {
475 my($self, $client, $user_session, $barcode) = @_;
476 warn "Searching for user with barcode $barcode\n";
477 my $user_obj = $apputils->check_user_session( $user_session );
479 my $session = OpenSRF::AppSession->create("open-ils.storage");
481 # find the card with the given barcode
482 my $creq = $session->request(
483 "open-ils.storage.direct.actor.card.search.barcode",
485 my $card = $creq->gather(1);
487 my $user = flesh_user($card->usr(), $session);
488 $session->disconnect();
495 __PACKAGE__->register_method(
496 method => "get_user_by_id",
497 api_name => "open-ils.actor.user.retrieve",);
500 my ($self, $client, $user_session, $id) = @_;
502 my $user_obj = $apputils->check_user_session( $user_session );
504 return $apputils->simple_scalar_request(
506 "open-ils.storage.direct.actor.user.retrieve",
512 __PACKAGE__->register_method(
513 method => "get_org_types",
514 api_name => "open-ils.actor.org_types.retrieve",);
518 my($self, $client) = @_;
520 return $org_types if $org_types;
522 $apputils->simple_scalar_request(
524 "open-ils.storage.direct.actor.org_unit_type.retrieve.all.atomic" );
529 __PACKAGE__->register_method(
530 method => "get_user_profiles",
531 api_name => "open-ils.actor.user.profiles.retrieve",
535 sub get_user_profiles {
536 return $user_profiles if $user_profiles;
538 return $user_profiles =
539 $apputils->simple_scalar_request(
541 "open-ils.storage.direct.actor.profile.retrieve.all.atomic");
546 __PACKAGE__->register_method(
547 method => "get_user_ident_types",
548 api_name => "open-ils.actor.user.ident_types.retrieve",
551 sub get_user_ident_types {
552 return $ident_types if $ident_types;
553 return $ident_types =
554 $apputils->simple_scalar_request(
556 "open-ils.storage.direct.config.identification_type.retrieve.all.atomic" );
562 __PACKAGE__->register_method(
563 method => "get_org_unit",
564 api_name => "open-ils.actor.org_unit.retrieve",
569 my( $self, $client, $user_session ) = @_;
572 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
574 my $home_ou = OpenILS::Application::AppUtils->simple_scalar_request(
576 "open-ils.storage.direct.actor.org_unit.retrieve",
577 $user_obj->home_ou );
585 __PACKAGE__->register_method(
586 method => "get_org_tree",
587 api_name => "open-ils.actor.org_tree.retrieve",
589 note => "Returns the entire org tree structure",
593 my( $self, $client) = @_;
595 # see if it's in the cache
596 warn "Getting ORG Tree\n";
597 my $tree = $cache_client->get_cache('orgtree');
599 warn "Found orgtree in cache. returning...\n";
603 my $orglist = $apputils->simple_scalar_request(
605 "open-ils.storage.direct.actor.org_unit.retrieve.all.atomic" );
607 $tree = $self->build_org_tree($orglist);
608 $cache_client->put_cache('orgtree', $tree);
614 # turns an org list into an org tree
617 my( $self, $orglist) = @_;
619 return $orglist unless (
620 ref($orglist) and @$orglist > 1 );
623 $a->ou_type <=> $b->ou_type ||
624 $a->name cmp $b->name } @$orglist;
626 for my $org (@list) {
628 next unless ($org and defined($org->parent_ou));
629 my ($parent) = grep { $_->id == $org->parent_ou } @list;
632 $parent->children([]) unless defined($parent->children);
633 push( @{$parent->children}, $org );
641 __PACKAGE__->register_method(
642 method => "get_org_descendants",
643 api_name => "open-ils.actor.org_tree.descendants.retrieve"
646 # depth is optional. org_unit is the id
647 sub get_org_descendants {
648 my( $self, $client, $org_unit, $depth ) = @_;
649 my $orglist = $apputils->simple_scalar_request(
651 "open-ils.storage.actor.org_unit.descendants.atomic",
653 return $self->build_org_tree($orglist);
657 __PACKAGE__->register_method(
658 method => "get_org_ancestors",
659 api_name => "open-ils.actor.org_tree.ancestors.retrieve"
662 # depth is optional. org_unit is the id
663 sub get_org_ancestors {
664 my( $self, $client, $org_unit, $depth ) = @_;
665 my $orglist = $apputils->simple_scalar_request(
667 "open-ils.storage.actor.org_unit.ancestors.atomic",
669 return $self->build_org_tree($orglist);
673 __PACKAGE__->register_method(
674 method => "get_standings",
675 api_name => "open-ils.actor.standings.retrieve"
680 return $user_standings if $user_standings;
681 return $user_standings =
682 $apputils->simple_scalar_request(
684 "open-ils.storage.direct.config.standing.retrieve.all.atomic" );
689 __PACKAGE__->register_method(
690 method => "get_my_org_path",
691 api_name => "open-ils.actor.org_unit.full_path.retrieve"
694 sub get_my_org_path {
695 my( $self, $client, $user_session, $org_id ) = @_;
696 my $user_obj = $apputils->check_user_session($user_session);
697 if(!defined($org_id)) { $org_id = $user_obj->home_ou; }
699 return $apputils->simple_scalar_request(
701 "open-ils.storage.actor.org_unit.full_path.atomic",
706 __PACKAGE__->register_method(
707 method => "patron_adv_search",
708 api_name => "open-ils.actor.patron.search.advanced" );
710 sub patron_adv_search {
711 my( $self, $client, $staff_login, $search_hash ) = @_;
714 warn "patron adv with $staff_login and search " .
715 Dumper($search_hash) . "\n";
717 my $session = OpenSRF::AppSession->create("open-ils.storage");
718 my $req = $session->request(
719 "open-ils.storage.actor.user.crazy_search", $search_hash);
721 my $ans = $req->gather(1);
722 $session->disconnect();
742 some old methods that may be good to keep around for now
745 my( $session, $card ) = @_;
747 warn "Deleting card with barcode " . $card->barcode() . "\n";
748 my $req = $session->request(
749 "open-ils.storage.direct.actor.card.delete",
751 my $status = $req->gather(1);
752 if(!defined($status)) {
753 throw OpenSRF::EX::ERROR
754 ("Unknown error updating card");
760 # deletes the patron and any attached addresses and cards
761 __PACKAGE__->register_method(
762 method => "delete_patron",
763 api_name => "open-ils.actor.patron.delete",
768 my( $self, $client, $patron ) = @_;
769 my $session = $apputils->start_db_session();
774 $patron->clear_mailing_address();
775 $patron->clear_billing_address();
776 $patron->ischanged(1);
778 _update_patron($session, $patron);
779 _delete_address($session,$_) for (@{$patron->addresses()});
780 _delete_card($session,$_) for (@{$patron->cards()});
781 _delete_patron($session,$patron);
782 $apputils->commit_db_session($session);
786 $err = "-*- Failure deleting user: $e";
787 $apputils->rollback_db_session($session);
791 if($err) { throw OpenSRF::EX::ERROR ($err); }
792 warn "Patron Delete complete\n";
797 my( $session, $patron ) = @_;
799 warn "Deleting patron " . $patron->usrname() . "\n";
801 my $req = $session->request(
802 "open-ils.storage.direct.actor.user.delete",
804 my $status = $req->gather(1);
805 if(!defined($status)) {
806 throw OpenSRF::EX::ERROR
807 ("Unknown error updating patron");