1 package OpenILS::Application::Actor;
2 use base qw/OpenSRF::Application/;
3 use strict; use warnings;
6 use Digest::MD5 qw(md5_hex);
8 use OpenSRF::EX qw(:try);
11 use OpenILS::Application::AppUtils;
12 use OpenILS::Utils::Fieldmapper;
13 use OpenILS::Application::Search::Actor;
15 my $apputils = "OpenILS::Application::AppUtils";
16 sub _d { warn "Patron:\n" . Dumper(shift()); }
17 my $cache_client = OpenSRF::Utils::Cache->new("global", 0);
20 __PACKAGE__->register_method(
21 method => "update_patron",
22 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());
94 __PACKAGE__->register_method(
95 method => "user_retrieve_fleshed_by_id",
96 api_name => "open-ils.actor.user.fleshed.retrieve",);
98 sub user_retrieve_fleshed_by_id {
99 my( $self, $client, $user_session, $user_id ) = @_;
100 my $user_obj = $apputils->check_user_session( $user_session );
101 return flesh_user($user_id);
112 $session = OpenSRF::AppSession->create("open-ils.storage");
116 # grab the user with the given id
117 my $ureq = $session->request(
118 "open-ils.storage.direct.actor.user.retrieve", $id);
119 my $user = $ureq->gather(1);
122 my $cards_req = $session->request(
123 "open-ils.storage.direct.actor.card.search.usr",
125 $user->cards( $cards_req->gather(1) );
127 for my $c(@{$user->cards}) {
128 if($c->id == $user->card || $c->id eq $user->card ) {
129 warn "Setting my card to " . $c->id . "\n";
134 my $add_req = $session->request(
135 "open-ils.storage.direct.actor.user_address.search.usr",
137 $user->addresses( $add_req->gather(1) );
139 for my $c(@{$user->addresses}) {
140 if($c->id == $user->billing_address || $c->id eq $user->billing_address ) {
141 warn "Setting my address to " . $c->id . "\n";
142 $user->billing_address($c);
146 for my $c(@{$user->addresses}) {
147 if($c->id == $user->mailing_address || $c->id eq $user->mailing_address ) {
148 warn "Setting my address to " . $c->id . "\n";
149 $user->mailing_address($c);
153 my $stat_req = $session->request(
154 "open-ils.storage.direct.actor.stat_cat_entry_user_map.search.target_usr",
156 $user->stat_cat_entries($stat_req->gather(1));
158 if($kill) { $session->disconnect(); }
159 $user->clear_passwd();
167 # clone and clear stuff that would break the database
171 my $new_patron = Fieldmapper::actor::user->new();
173 my $fmap = $Fieldmapper::fieldmap;
174 no strict; # shallow clone, may be useful in the fieldmapper
176 (keys %{$fmap->{"Fieldmapper::actor::user"}->{'fields'}}) {
177 $new_patron->$field( $patron->$field() );
182 $new_patron->clear_billing_address();
183 $new_patron->clear_mailing_address();
184 $new_patron->clear_addresses();
185 $new_patron->clear_card();
186 $new_patron->clear_cards();
187 $new_patron->clear_id();
188 $new_patron->clear_isnew();
189 $new_patron->clear_changed();
190 $new_patron->clear_deleted();
191 $new_patron->clear_stat_cat_entries();
201 warn "Creating new patron\n";
204 my $req = $session->request(
205 "open-ils.storage.direct.actor.user.create",$patron);
206 my $id = $req->gather(1);
208 return OpenILS::EX->new("DUPLICATE_USER_USERNAME");
211 # retrieve the patron from the db to collect defaults
212 my $ureq = $session->request(
213 "open-ils.storage.direct.actor.user.retrieve",
216 warn "Created new patron with id $id\n";
218 return $ureq->gather(1);
223 my( $session, $patron) = @_;
225 warn "updating patron " . Dumper($patron) . "\n";
227 my $req = $session->request(
228 "open-ils.storage.direct.actor.user.update",$patron );
229 my $status = $req->gather(1);
230 if(!defined($status)) {
231 throw OpenSRF::EX::ERROR
232 ("Unknown error updating patron");
238 sub _add_update_addresses {
241 my $new_patron = shift;
243 my $current_id; # id of the address before creation
245 for my $address (@{$patron->addresses()}) {
247 $address->usr($new_patron->id());
249 if(ref($address) and $address->isnew()) {
250 warn "Adding new address at street " . $address->street1() . "\n";
252 $current_id = $address->id();
253 $address = _add_address($session,$address);
255 if( $patron->billing_address() and
256 $patron->billing_address() == $current_id ) {
257 $new_patron->billing_address($address->id());
258 $new_patron->ischanged(1);
261 if( $patron->mailing_address() and
262 $patron->mailing_address() == $current_id ) {
263 $new_patron->mailing_address($address->id());
264 $new_patron->ischanged(1);
267 } elsif( ref($address) and $address->ischanged() ) {
268 warn "Updating address at street " . $address->street1();
269 $address->usr($new_patron->id());
270 _update_address($session,$address);
272 } elsif( ref($address) and $address->isdeleted() ) {
273 warn "Deleting address at street " . $address->street1();
275 if( $address->id() == $new_patron->mailing_address() ) {
276 $new_patron->clear_mailing_address();
277 _update_patron($session, $new_patron);
280 if( $address->id() == $new_patron->billing_address() ) {
281 $new_patron->clear_billing_address();
282 _update_patron($session, $new_patron);
285 _delete_address($session,$address);
293 # adds an address to the db and returns the address with new id
295 my($session, $address) = @_;
296 $address->clear_id();
298 # put the address into the database
299 my $req = $session->request(
300 "open-ils.storage.direct.actor.user_address.create",
304 my $id = $req->gather(1);
306 throw OpenSRF::EX::ERROR
307 ("Unable to create new user address");
310 warn "Created address with id $id\n";
312 # update all the necessary id's
318 sub _update_address {
319 my( $session, $address ) = @_;
320 my $req = $session->request(
321 "open-ils.storage.direct.actor.user_address.update",
323 my $status = $req->gather(1);
324 if(!defined($status)) {
325 throw OpenSRF::EX::ERROR
326 ("Unknown error updating address");
333 sub _add_update_cards {
337 my $new_patron = shift;
339 my $virtual_id; #id of the card before creation
340 for my $card (@{$patron->cards()}) {
342 $card->usr($new_patron->id());
344 if(ref($card) and $card->isnew()) {
346 $virtual_id = $card->id();
347 $card = _add_card($session,$card);
348 if(UNIVERSAL::isa($card,"OpenILS::EX")) {
352 if($patron->card() == $virtual_id) {
353 $new_patron->card($card->id());
354 $new_patron->ischanged(1);
357 } elsif( ref($card) and $card->ischanged() ) {
358 $card->usr($new_patron->id());
359 _update_card($session, $card);
366 # adds an card to the db and returns the card with new id
368 my( $session, $card ) = @_;
371 warn "Adding card with barcode " . $card->barcode() . "\n";
372 my $req = $session->request(
373 "open-ils.storage.direct.actor.card.create",
376 my $id = $req->gather(1);
378 return OpenILS::EX->new("DUPLICATE_INVALID_USER_BARCODE");
382 warn "Created patron card with id $id\n";
388 my( $session, $card ) = @_;
391 my $req = $session->request(
392 "open-ils.storage.direct.actor.card.update",
394 my $status = $req->gather(1);
395 if(!defined($status)) {
396 throw OpenSRF::EX::ERROR
397 ("Unknown error updating card");
405 sub _delete_address {
406 my( $session, $address ) = @_;
408 warn "Deleting address " . $address->street1() . "\n";
410 my $req = $session->request(
411 "open-ils.storage.direct.actor.user_address.delete",
413 my $status = $req->gather(1);
414 if(!defined($status)) {
415 throw OpenSRF::EX::ERROR
416 ("Unknown error updating address");
418 warn "Delete address status is $status\n";
423 sub _add_survey_responses {
424 my ($session, $patron, $new_patron) = @_;
426 warn "updating responses for user " . $new_patron->id . "\n";
428 my $responses = $patron->survey_responses;
429 for my $resp( @$responses ) {
430 $resp->usr($new_patron->id);
433 my $status = $apputils->simple_scalar_request(
435 "open-ils.circ.survey.submit.user_id",
442 sub _create_stat_maps {
444 my($session, $user_session, $patron, $new_patron) = @_;
446 my $maps = $patron->stat_cat_entries();
448 for my $map (@$maps) {
450 next unless($map->isnew() || $map->ischanged());
452 my $method = "open-ils.storage.direct.actor.stat_cat_entry_user_map.update";
454 $method = "open-ils.storage.direct.actor.stat_cat_entry_user_map.create";
457 $map->target_usr($new_patron->id);
459 warn "Updating stat entry with method $method and session $user_session and map $map\n";
461 my $req = $session->request($method, $map);
462 my $status = $req->gather(1);
467 throw OpenSRF::EX::ERROR
468 ("Error updating stat map with method $method");
477 __PACKAGE__->register_method(
478 method => "search_username",
479 api_name => "open-ils.actor.user.search.username",
482 sub search_username {
483 my($self, $client, $username) = @_;
484 my $users = OpenILS::Application::AppUtils->simple_scalar_request(
486 "open-ils.storage.direct.actor.user.search.usrname",
494 __PACKAGE__->register_method(
495 method => "user_retrieve_by_barcode",
496 api_name => "open-ils.actor.user.fleshed.retrieve_by_barcode",);
498 sub user_retrieve_by_barcode {
499 my($self, $client, $user_session, $barcode) = @_;
500 warn "Searching for user with barcode $barcode\n";
501 my $user_obj = $apputils->check_user_session( $user_session );
503 my $session = OpenSRF::AppSession->create("open-ils.storage");
505 # find the card with the given barcode
506 my $creq = $session->request(
507 "open-ils.storage.direct.actor.card.search.barcode",
509 my $card = $creq->gather(1);
511 if(!$card || !$card->[0]) {
512 $session->disconnect();
517 my $user = flesh_user($card->usr(), $session);
518 $session->disconnect();
525 __PACKAGE__->register_method(
526 method => "get_user_by_id",
527 api_name => "open-ils.actor.user.retrieve",);
530 my ($self, $client, $user_session, $id) = @_;
532 my $user_obj = $apputils->check_user_session( $user_session );
534 return $apputils->simple_scalar_request(
536 "open-ils.storage.direct.actor.user.retrieve",
542 __PACKAGE__->register_method(
543 method => "get_org_types",
544 api_name => "open-ils.actor.org_types.retrieve",);
548 my($self, $client) = @_;
550 return $org_types if $org_types;
552 $apputils->simple_scalar_request(
554 "open-ils.storage.direct.actor.org_unit_type.retrieve.all.atomic" );
559 __PACKAGE__->register_method(
560 method => "get_user_profiles",
561 api_name => "open-ils.actor.user.profiles.retrieve",
565 sub get_user_profiles {
566 return $user_profiles if $user_profiles;
568 return $user_profiles =
569 $apputils->simple_scalar_request(
571 "open-ils.storage.direct.actor.profile.retrieve.all.atomic");
576 __PACKAGE__->register_method(
577 method => "get_user_ident_types",
578 api_name => "open-ils.actor.user.ident_types.retrieve",
581 sub get_user_ident_types {
582 return $ident_types if $ident_types;
583 return $ident_types =
584 $apputils->simple_scalar_request(
586 "open-ils.storage.direct.config.identification_type.retrieve.all.atomic" );
592 __PACKAGE__->register_method(
593 method => "get_org_unit",
594 api_name => "open-ils.actor.org_unit.retrieve",
599 my( $self, $client, $user_session, $org_id ) = @_;
601 if(defined($user_session) && !defined($org_id)) {
603 OpenILS::Application::AppUtils->check_user_session( $user_session ); #throws EX on error
604 if(!defined($org_id)) {
605 $org_id = $user_obj->home_ou;
610 my $home_ou = OpenILS::Application::AppUtils->simple_scalar_request(
612 "open-ils.storage.direct.actor.org_unit.retrieve",
621 __PACKAGE__->register_method(
622 method => "get_org_tree",
623 api_name => "open-ils.actor.org_tree.retrieve",
625 note => "Returns the entire org tree structure",
629 my( $self, $client) = @_;
631 # see if it's in the cache
632 warn "Getting ORG Tree\n";
633 my $tree = $cache_client->get_cache('orgtree');
635 warn "Found orgtree in cache. returning...\n";
639 my $orglist = $apputils->simple_scalar_request(
641 "open-ils.storage.direct.actor.org_unit.retrieve.all.atomic" );
643 $tree = $self->build_org_tree($orglist);
644 $cache_client->put_cache('orgtree', $tree);
650 # turns an org list into an org tree
653 my( $self, $orglist) = @_;
655 return $orglist unless (
656 ref($orglist) and @$orglist > 1 );
659 $a->ou_type <=> $b->ou_type ||
660 $a->name cmp $b->name } @$orglist;
662 for my $org (@list) {
664 next unless ($org and defined($org->parent_ou));
665 my ($parent) = grep { $_->id == $org->parent_ou } @list;
668 $parent->children([]) unless defined($parent->children);
669 push( @{$parent->children}, $org );
677 __PACKAGE__->register_method(
678 method => "get_org_descendants",
679 api_name => "open-ils.actor.org_tree.descendants.retrieve"
682 # depth is optional. org_unit is the id
683 sub get_org_descendants {
684 my( $self, $client, $org_unit, $depth ) = @_;
685 my $orglist = $apputils->simple_scalar_request(
687 "open-ils.storage.actor.org_unit.descendants.atomic",
689 return $self->build_org_tree($orglist);
693 __PACKAGE__->register_method(
694 method => "get_org_ancestors",
695 api_name => "open-ils.actor.org_tree.ancestors.retrieve"
698 # depth is optional. org_unit is the id
699 sub get_org_ancestors {
700 my( $self, $client, $org_unit, $depth ) = @_;
701 my $orglist = $apputils->simple_scalar_request(
703 "open-ils.storage.actor.org_unit.ancestors.atomic",
705 return $self->build_org_tree($orglist);
709 __PACKAGE__->register_method(
710 method => "get_standings",
711 api_name => "open-ils.actor.standings.retrieve"
716 return $user_standings if $user_standings;
717 return $user_standings =
718 $apputils->simple_scalar_request(
720 "open-ils.storage.direct.config.standing.retrieve.all.atomic" );
725 __PACKAGE__->register_method(
726 method => "get_my_org_path",
727 api_name => "open-ils.actor.org_unit.full_path.retrieve"
730 sub get_my_org_path {
731 my( $self, $client, $user_session, $org_id ) = @_;
732 my $user_obj = $apputils->check_user_session($user_session);
733 if(!defined($org_id)) { $org_id = $user_obj->home_ou; }
735 return $apputils->simple_scalar_request(
737 "open-ils.storage.actor.org_unit.full_path.atomic",
742 __PACKAGE__->register_method(
743 method => "patron_adv_search",
744 api_name => "open-ils.actor.patron.search.advanced" );
746 sub patron_adv_search {
747 my( $self, $client, $staff_login, $search_hash ) = @_;
750 warn "patron adv with $staff_login and search " .
751 Dumper($search_hash) . "\n";
753 my $session = OpenSRF::AppSession->create("open-ils.storage");
754 my $req = $session->request(
755 "open-ils.storage.actor.user.crazy_search", $search_hash);
757 my $ans = $req->gather(1);
759 my %hash = map { ($_ =>1) } @$ans;
760 $ans = [ keys %hash ];
762 warn "Returning @$ans\n";
764 $session->disconnect();
771 sub _verify_password {
772 my($user_session, $password) = @_;
773 my $user_obj = $apputils->check_user_session($user_session);
775 #grab the user with password
776 $user_obj = $apputils->simple_scalar_request(
778 "open-ils.storage.direct.actor.user.retrieve",
781 if($user_obj->passwd eq $password) {
789 __PACKAGE__->register_method(
790 method => "update_password",
791 api_name => "open-ils.actor.user.password.update");
793 __PACKAGE__->register_method(
794 method => "update_password",
795 api_name => "open-ils.actor.user.username.update");
797 __PACKAGE__->register_method(
798 method => "update_password",
799 api_name => "open-ils.actor.user.email.update");
801 sub update_password {
802 my( $self, $client, $user_session, $new_value, $current_password ) = @_;
804 warn "Updating user with method " .$self->api_name . "\n";
805 my $user_obj = $apputils->check_user_session($user_session);
807 if($self->api_name =~ /password/) {
809 #make sure they know the current password
810 if(!_verify_password($user_session, md5_hex($current_password))) {
811 return OpenILS::EX->new("USER_WRONG_PASSWORD")->ex;
814 $user_obj->passwd($new_value);
816 elsif($self->api_name =~ /username/) {
817 $user_obj->usrname($new_value);
820 elsif($self->api_name =~ /email/) {
821 warn "Updating email to $new_value\n";
822 $user_obj->email($new_value);
825 my $session = $apputils->start_db_session();
826 $user_obj = _update_patron($session, $user_obj);
827 $apputils->commit_db_session($session);
829 if($user_obj) { return 1; }
834 # returns undef on success, the first perm_type that failed
835 # on permission error
837 __PACKAGE__->register_method(
838 method => "check_user_perms",
839 api_name => "open-ils.actor.user.perm.check");
841 sub check_user_perms {
842 my( $self, $client, $user_id, $org_id, @perm_types ) = @_;
859 some old methods that may be good to keep around for now
862 my( $session, $card ) = @_;
864 warn "Deleting card with barcode " . $card->barcode() . "\n";
865 my $req = $session->request(
866 "open-ils.storage.direct.actor.card.delete",
868 my $status = $req->gather(1);
869 if(!defined($status)) {
870 throw OpenSRF::EX::ERROR
871 ("Unknown error updating card");
877 # deletes the patron and any attached addresses and cards
878 __PACKAGE__->register_method(
879 method => "delete_patron",
880 api_name => "open-ils.actor.patron.delete",
885 my( $self, $client, $patron ) = @_;
886 my $session = $apputils->start_db_session();
891 $patron->clear_mailing_address();
892 $patron->clear_billing_address();
893 $patron->ischanged(1);
895 _update_patron($session, $patron);
896 _delete_address($session,$_) for (@{$patron->addresses()});
897 _delete_card($session,$_) for (@{$patron->cards()});
898 _delete_patron($session,$patron);
899 $apputils->commit_db_session($session);
903 $err = "-*- Failure deleting user: $e";
904 $apputils->rollback_db_session($session);
908 if($err) { throw OpenSRF::EX::ERROR ($err); }
909 warn "Patron Delete complete\n";
914 my( $session, $patron ) = @_;
916 warn "Deleting patron " . $patron->usrname() . "\n";
918 my $req = $session->request(
919 "open-ils.storage.direct.actor.user.delete",
921 my $status = $req->gather(1);
922 if(!defined($status)) {
923 throw OpenSRF::EX::ERROR
924 ("Unknown error updating patron");