3 # Copyright ByWater Solutions 2014
4 # Copyright PTFS Europe 2016
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 use List::MoreUtils qw( uniq );
25 use JSON qw( to_json );
26 use Text::Unaccent qw( unac_string );
35 use Koha::Exceptions::Password;
37 use Koha::Old::Checkouts;
38 use Koha::Patron::Categories;
39 use Koha::Patron::HouseboundProfile;
40 use Koha::Patron::HouseboundRole;
41 use Koha::Patron::Images;
43 use Koha::Virtualshelves;
44 use Koha::Club::Enrollments;
46 use Koha::Subscription::Routinglists;
48 use base qw(Koha::Object);
50 our $RESULTSET_PATRON_ID_MAPPING = {
51 Accountline => 'borrowernumber',
52 Aqbasketuser => 'borrowernumber',
53 Aqbudget => 'budget_owner_id',
54 Aqbudgetborrower => 'borrowernumber',
55 ArticleRequest => 'borrowernumber',
56 BorrowerAttribute => 'borrowernumber',
57 BorrowerDebarment => 'borrowernumber',
58 BorrowerFile => 'borrowernumber',
59 BorrowerModification => 'borrowernumber',
60 ClubEnrollment => 'borrowernumber',
61 Issue => 'borrowernumber',
62 ItemsLastBorrower => 'borrowernumber',
63 Linktracker => 'borrowernumber',
64 Message => 'borrowernumber',
65 MessageQueue => 'borrowernumber',
66 OldIssue => 'borrowernumber',
67 OldReserve => 'borrowernumber',
68 Rating => 'borrowernumber',
69 Reserve => 'borrowernumber',
70 Review => 'borrowernumber',
71 SearchHistory => 'userid',
72 Statistic => 'borrowernumber',
73 Suggestion => 'suggestedby',
74 TagAll => 'borrowernumber',
75 Virtualshelfcontent => 'borrowernumber',
76 Virtualshelfshare => 'borrowernumber',
77 Virtualshelve => 'owner',
82 Koha::Patron - Koha Patron Object class
95 my ( $class, $params ) = @_;
97 return $class->SUPER::new($params);
100 =head3 fixup_cardnumber
102 Autogenerate next cardnumber from highest value found in database
106 sub fixup_cardnumber {
108 my $max = Koha::Patrons->search({
109 cardnumber => {-regexp => '^-?[0-9]+$'}
111 select => \'CAST(cardnumber AS SIGNED)',
112 as => ['cast_cardnumber']
113 })->_resultset->get_column('cast_cardnumber')->max;
114 $self->cardnumber(($max || 0) +1);
117 =head3 trim_whitespace
119 trim whitespace from data which has some non-whitespace in it.
120 Could be moved to Koha::Object if need to be reused
124 sub trim_whitespaces {
127 my $schema = Koha::Database->new->schema;
128 my @columns = $schema->source($self->_type)->columns;
130 for my $column( @columns ) {
131 my $value = $self->$column;
132 if ( defined $value ) {
133 $value =~ s/^\s*|\s*$//g;
134 $self->$column($value);
140 =head3 plain_text_password
142 $patron->plain_text_password( $password );
144 stores a copy of the unencrypted password in the object
145 for use in code before encrypting for db
149 sub plain_text_password {
150 my ( $self, $password ) = @_;
152 $self->{_plain_text_password} = $password;
155 return $self->{_plain_text_password}
156 if $self->{_plain_text_password};
163 Patron specific store method to cleanup record
164 and do other necessary things before saving
172 $self->_result->result_source->schema->txn_do(
175 C4::Context->preference("autoMemberNum")
176 and ( not defined $self->cardnumber
177 or $self->cardnumber eq '' )
180 # Warning: The caller is responsible for locking the members table in write
181 # mode, to avoid database corruption.
182 # We are in a transaction but the table is not locked
183 $self->fixup_cardnumber;
186 unless( $self->category->in_storage ) {
187 Koha::Exceptions::Object::FKConstraint->throw(
188 broken_fk => 'categorycode',
189 value => $self->categorycode,
193 $self->trim_whitespaces;
195 unless ( $self->in_storage ) { #AddMember
197 # Generate a valid userid/login if needed
198 $self->generate_userid
199 if not $self->userid or not $self->has_valid_userid;
201 # Add expiration date if it isn't already there
202 unless ( $self->dateexpiry ) {
203 $self->dateexpiry( $self->category->get_expiry_date );
206 # Add enrollment date if it isn't already there
207 unless ( $self->dateenrolled ) {
208 $self->dateenrolled(dt_from_string);
211 # Set the privacy depending on the patron's category
212 my $default_privacy = $self->category->default_privacy || q{};
214 $default_privacy eq 'default' ? 1
215 : $default_privacy eq 'never' ? 2
216 : $default_privacy eq 'forever' ? 0
218 $self->privacy($default_privacy);
221 # Make a copy of the plain text password for later use
222 $self->plain_text_password( $self->password );
224 # Create a disabled account if no password provided
225 $self->password( $self->password
226 ? Koha::AuthUtils::hash_password( $self->password )
229 $self->borrowernumber(undef);
231 $self = $self->SUPER::store;
233 $self->add_enrolment_fee_if_needed;
235 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
236 if C4::Context->preference("BorrowersLog");
240 my $self_from_storage = $self->get_from_storage;
241 # FIXME We should not deal with that here, callers have to do this job
242 # Moved from ModMember to prevent regressions
243 unless ( $self->userid ) {
244 my $stored_userid = $self_from_storage->userid;
245 $self->userid($stored_userid);
248 # Password must be updated using $self->set_password
249 $self->password($self_from_storage->password);
251 if ( C4::Context->preference('FeeOnChangePatronCategory')
252 and $self->category->categorycode ne
253 $self_from_storage->category->categorycode )
255 $self->add_enrolment_fee_if_needed;
258 my $borrowers_log = C4::Context->preference("BorrowersLog");
259 my $previous_cardnumber = $self_from_storage->cardnumber;
261 && ( !defined $previous_cardnumber
262 || $previous_cardnumber ne $self->cardnumber )
268 $self->borrowernumber,
271 cardnumber_replaced => {
272 previous_cardnumber => $previous_cardnumber,
273 new_cardnumber => $self->cardnumber,
276 { utf8 => 1, pretty => 1 }
281 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
282 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
285 $self = $self->SUPER::store;
296 Delete patron's holds, lists and finally the patron.
298 Lists owned by the borrower are deleted, but entries from the borrower to
299 other lists are kept.
307 $self->_result->result_source->schema->txn_do(
309 # Delete Patron's holds
310 $self->holds->delete;
312 # Delete all lists and all shares of this borrower
313 # Consistent with the approach Koha uses on deleting individual lists
314 # Note that entries in virtualshelfcontents added by this borrower to
315 # lists of others will be handled by a table constraint: the borrower
316 # is set to NULL in those entries.
318 # We could handle the above deletes via a constraint too.
319 # But a new BZ report 11889 has been opened to discuss another approach.
320 # Instead of deleting we could also disown lists (based on a pref).
321 # In that way we could save shared and public lists.
322 # The current table constraints support that idea now.
323 # This pref should then govern the results of other routines/methods such as
324 # Koha::Virtualshelf->new->delete too.
325 # FIXME Could be $patron->get_lists
326 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
328 $deleted = $self->SUPER::delete;
330 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
339 my $patron_category = $patron->category
341 Return the patron category for this patron
347 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
352 Returns a Koha::Patron object for this patron's guarantor
359 return unless $self->guarantorid();
361 return Koha::Patrons->find( $self->guarantorid() );
367 return scalar Koha::Patron::Images->find( $self->borrowernumber );
372 return Koha::Library->_new_from_dbic($self->_result->branchcode);
377 Returns the guarantees (list of Koha::Patron) of this patron
384 return Koha::Patrons->search( { guarantorid => $self->borrowernumber }, { order_by => { -asc => ['surname','firstname'] } } );
387 =head3 housebound_profile
389 Returns the HouseboundProfile associated with this patron.
393 sub housebound_profile {
395 my $profile = $self->_result->housebound_profile;
396 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
401 =head3 housebound_role
403 Returns the HouseboundRole associated with this patron.
407 sub housebound_role {
410 my $role = $self->_result->housebound_role;
411 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
417 Returns the siblings of this patron.
424 my $guarantor = $self->guarantor;
426 return unless $guarantor;
428 return Koha::Patrons->search(
432 '=' => $guarantor->id,
435 '!=' => $self->borrowernumber,
443 my $patron = Koha::Patrons->find($id);
444 $patron->merge_with( \@patron_ids );
446 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
447 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
448 of the keeper patron.
453 my ( $self, $patron_ids ) = @_;
455 my @patron_ids = @{ $patron_ids };
457 # Ensure the keeper isn't in the list of patrons to merge
458 @patron_ids = grep { $_ ne $self->id } @patron_ids;
460 my $schema = Koha::Database->new()->schema();
464 $self->_result->result_source->schema->txn_do( sub {
465 foreach my $patron_id (@patron_ids) {
466 my $patron = Koha::Patrons->find( $patron_id );
470 # Unbless for safety, the patron will end up being deleted
471 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
473 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
474 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
475 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
476 $rs->update({ $field => $self->id });
479 $patron->move_to_deleted();
489 =head3 wants_check_for_previous_checkout
491 $wants_check = $patron->wants_check_for_previous_checkout;
493 Return 1 if Koha needs to perform PrevIssue checking, else 0.
497 sub wants_check_for_previous_checkout {
499 my $syspref = C4::Context->preference("checkPrevCheckout");
502 ## Hard syspref trumps all
503 return 1 if ($syspref eq 'hardyes');
504 return 0 if ($syspref eq 'hardno');
505 ## Now, patron pref trumps all
506 return 1 if ($self->checkprevcheckout eq 'yes');
507 return 0 if ($self->checkprevcheckout eq 'no');
509 # More complex: patron inherits -> determine category preference
510 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
511 return 1 if ($checkPrevCheckoutByCat eq 'yes');
512 return 0 if ($checkPrevCheckoutByCat eq 'no');
514 # Finally: category preference is inherit, default to 0
515 if ($syspref eq 'softyes') {
522 =head3 do_check_for_previous_checkout
524 $do_check = $patron->do_check_for_previous_checkout($item);
526 Return 1 if the bib associated with $ITEM has previously been checked out to
527 $PATRON, 0 otherwise.
531 sub do_check_for_previous_checkout {
532 my ( $self, $item ) = @_;
534 # Find all items for bib and extract item numbers.
535 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
537 foreach my $item (@items) {
538 push @item_nos, $item->itemnumber;
541 # Create (old)issues search criteria
543 borrowernumber => $self->borrowernumber,
544 itemnumber => \@item_nos,
547 # Check current issues table
548 my $issues = Koha::Checkouts->search($criteria);
549 return 1 if $issues->count; # 0 || N
551 # Check old issues table
552 my $old_issues = Koha::Old::Checkouts->search($criteria);
553 return $old_issues->count; # 0 || N
558 my $debarment_expiration = $patron->is_debarred;
560 Returns the date a patron debarment will expire, or undef if the patron is not
568 return unless $self->debarred;
569 return $self->debarred
570 if $self->debarred =~ '^9999'
571 or dt_from_string( $self->debarred ) > dt_from_string;
577 my $is_expired = $patron->is_expired;
579 Returns 1 if the patron is expired or 0;
585 return 0 unless $self->dateexpiry;
586 return 0 if $self->dateexpiry =~ '^9999';
587 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
591 =head3 is_going_to_expire
593 my $is_going_to_expire = $patron->is_going_to_expire;
595 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
599 sub is_going_to_expire {
602 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
604 return 0 unless $delay;
605 return 0 unless $self->dateexpiry;
606 return 0 if $self->dateexpiry =~ '^9999';
607 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
613 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
615 Set the patron's password.
619 The passed string is validated against the current password enforcement policy.
620 Validation can be skipped by passing the I<skip_validation> parameter.
622 Exceptions are thrown if the password is not good enough.
626 =item Koha::Exceptions::Password::TooShort
628 =item Koha::Exceptions::Password::WhitespaceCharacters
630 =item Koha::Exceptions::Password::TooWeak
637 my ( $self, $args ) = @_;
639 my $password = $args->{password};
641 unless ( $args->{skip_validation} ) {
642 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password );
645 if ( $error eq 'too_short' ) {
646 my $min_length = C4::Context->preference('minPasswordLength');
647 $min_length = 3 if not $min_length or $min_length < 3;
649 my $password_length = length($password);
650 Koha::Exceptions::Password::TooShort->throw(
651 length => $password_length, min_length => $min_length );
653 elsif ( $error eq 'has_whitespaces' ) {
654 Koha::Exceptions::Password::WhitespaceCharacters->throw();
656 elsif ( $error eq 'too_weak' ) {
657 Koha::Exceptions::Password::TooWeak->throw();
662 my $digest = Koha::AuthUtils::hash_password($password);
664 { password => $digest,
669 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
670 if C4::Context->preference("BorrowersLog");
678 my $new_expiry_date = $patron->renew_account
680 Extending the subscription to the expiry date.
687 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
688 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
691 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
692 ? dt_from_string( $self->dateexpiry )
695 my $expiry_date = $self->category->get_expiry_date($date);
697 $self->dateexpiry($expiry_date);
698 $self->date_renewed( dt_from_string() );
701 $self->add_enrolment_fee_if_needed;
703 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
704 return dt_from_string( $expiry_date )->truncate( to => 'day' );
709 my $has_overdues = $patron->has_overdues;
711 Returns the number of patron's overdues
717 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
718 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
723 $patron->track_login;
724 $patron->track_login({ force => 1 });
726 Tracks a (successful) login attempt.
727 The preference TrackLastPatronActivity must be enabled. Or you
728 should pass the force parameter.
733 my ( $self, $params ) = @_;
736 !C4::Context->preference('TrackLastPatronActivity');
737 $self->lastseen( dt_from_string() )->store;
740 =head3 move_to_deleted
742 my $is_moved = $patron->move_to_deleted;
744 Move a patron to the deletedborrowers table.
745 This can be done before deleting a patron, to make sure the data are not completely deleted.
749 sub move_to_deleted {
751 my $patron_infos = $self->unblessed;
752 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
753 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
756 =head3 article_requests
758 my @requests = $borrower->article_requests();
759 my $requests = $borrower->article_requests();
761 Returns either a list of ArticleRequests objects,
762 or an ArtitleRequests object, depending on the
767 sub article_requests {
770 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
772 return $self->{_article_requests};
775 =head3 article_requests_current
777 my @requests = $patron->article_requests_current
779 Returns the article requests associated with this patron that are incomplete
783 sub article_requests_current {
786 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
788 borrowernumber => $self->id(),
790 { status => Koha::ArticleRequest::Status::Pending },
791 { status => Koha::ArticleRequest::Status::Processing }
796 return $self->{_article_requests_current};
799 =head3 article_requests_finished
801 my @requests = $biblio->article_requests_finished
803 Returns the article requests associated with this patron that are completed
807 sub article_requests_finished {
808 my ( $self, $borrower ) = @_;
810 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
812 borrowernumber => $self->id(),
814 { status => Koha::ArticleRequest::Status::Completed },
815 { status => Koha::ArticleRequest::Status::Canceled }
820 return $self->{_article_requests_finished};
823 =head3 add_enrolment_fee_if_needed
825 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
827 Add enrolment fee for a patron if needed.
831 sub add_enrolment_fee_if_needed {
833 my $enrolment_fee = $self->category->enrolmentfee;
834 if ( $enrolment_fee && $enrolment_fee > 0 ) {
835 # insert fee in patron debts
836 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
838 return $enrolment_fee || 0;
843 my $checkouts = $patron->checkouts
849 my $checkouts = $self->_result->issues;
850 return Koha::Checkouts->_new_from_dbic( $checkouts );
853 =head3 pending_checkouts
855 my $pending_checkouts = $patron->pending_checkouts
857 This method will return the same as $self->checkouts, but with a prefetch on
858 items, biblio and biblioitems.
860 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
862 It should not be used directly, prefer to access fields you need instead of
863 retrieving all these fields in one go.
868 sub pending_checkouts {
870 my $checkouts = $self->_result->issues->search(
874 { -desc => 'me.timestamp' },
875 { -desc => 'issuedate' },
876 { -desc => 'issue_id' }, # Sort by issue_id should be enough
878 prefetch => { item => { biblio => 'biblioitems' } },
881 return Koha::Checkouts->_new_from_dbic( $checkouts );
886 my $old_checkouts = $patron->old_checkouts
892 my $old_checkouts = $self->_result->old_issues;
893 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
898 my $overdue_items = $patron->get_overdues
900 Return the overdue items
906 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
907 return $self->checkouts->search(
909 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
912 prefetch => { item => { biblio => 'biblioitems' } },
917 =head3 get_routing_lists
919 my @routinglists = $patron->get_routing_lists
921 Returns the routing lists a patron is subscribed to.
925 sub get_routing_lists {
927 my $routing_list_rs = $self->_result->subscriptionroutinglists;
928 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
933 my $age = $patron->get_age
935 Return the age of the patron
941 my $today_str = dt_from_string->strftime("%Y-%m-%d");
942 return unless $self->dateofbirth;
943 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
945 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
946 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
948 my $age = $today_y - $dob_y;
949 if ( $dob_m . $dob_d > $today_m . $today_d ) {
958 my $account = $patron->account
964 return Koha::Account->new( { patron_id => $self->borrowernumber } );
969 my $holds = $patron->holds
971 Return all the holds placed by this patron
977 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
978 return Koha::Holds->_new_from_dbic($holds_rs);
983 my $old_holds = $patron->old_holds
985 Return all the historical holds for this patron
991 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
992 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
995 =head3 notice_email_address
997 my $email = $patron->notice_email_address;
999 Return the email address of patron used for notices.
1000 Returns the empty string if no email address.
1004 sub notice_email_address{
1007 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1008 # if syspref is set to 'first valid' (value == OFF), look up email address
1009 if ( $which_address eq 'OFF' ) {
1010 return $self->first_valid_email_address;
1013 return $self->$which_address || '';
1016 =head3 first_valid_email_address
1018 my $first_valid_email_address = $patron->first_valid_email_address
1020 Return the first valid email address for a patron.
1021 For now, the order is defined as email, emailpro, B_email.
1022 Returns the empty string if the borrower has no email addresses.
1026 sub first_valid_email_address {
1029 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1032 =head3 get_club_enrollments
1036 sub get_club_enrollments {
1037 my ( $self, $return_scalar ) = @_;
1039 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1041 return $e if $return_scalar;
1043 return wantarray ? $e->as_list : $e;
1046 =head3 get_enrollable_clubs
1050 sub get_enrollable_clubs {
1051 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1054 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1055 if $is_enrollable_from_opac;
1056 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1058 $params->{borrower} = $self;
1060 my $e = Koha::Clubs->get_enrollable($params);
1062 return $e if $return_scalar;
1064 return wantarray ? $e->as_list : $e;
1067 =head3 account_locked
1069 my $is_locked = $patron->account_locked
1071 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1072 Otherwise return false.
1073 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1077 sub account_locked {
1079 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1080 return ( $FailedLoginAttempts
1081 and $self->login_attempts
1082 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1085 =head3 can_see_patron_infos
1087 my $can_see = $patron->can_see_patron_infos( $patron );
1089 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1093 sub can_see_patron_infos {
1094 my ( $self, $patron ) = @_;
1095 return $self->can_see_patrons_from( $patron->library->branchcode );
1098 =head3 can_see_patrons_from
1100 my $can_see = $patron->can_see_patrons_from( $branchcode );
1102 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1106 sub can_see_patrons_from {
1107 my ( $self, $branchcode ) = @_;
1109 if ( $self->branchcode eq $branchcode ) {
1111 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1113 } elsif ( my $library_groups = $self->library->library_groups ) {
1114 while ( my $library_group = $library_groups->next ) {
1115 if ( $library_group->parent->has_child( $branchcode ) ) {
1124 =head3 libraries_where_can_see_patrons
1126 my $libraries = $patron-libraries_where_can_see_patrons;
1128 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1129 The branchcodes are arbitrarily returned sorted.
1130 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1132 An empty array means no restriction, the patron can see patron's infos from any libraries.
1136 sub libraries_where_can_see_patrons {
1138 my $userenv = C4::Context->userenv;
1140 return () unless $userenv; # For tests, but userenv should be defined in tests...
1142 my @restricted_branchcodes;
1143 if (C4::Context::only_my_library) {
1144 push @restricted_branchcodes, $self->branchcode;
1148 $self->has_permission(
1149 { borrowers => 'view_borrower_infos_from_any_libraries' }
1153 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1154 if ( $library_groups->count )
1156 while ( my $library_group = $library_groups->next ) {
1157 my $parent = $library_group->parent;
1158 if ( $parent->has_child( $self->branchcode ) ) {
1159 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1164 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1168 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1169 @restricted_branchcodes = uniq(@restricted_branchcodes);
1170 @restricted_branchcodes = sort(@restricted_branchcodes);
1171 return @restricted_branchcodes;
1174 sub has_permission {
1175 my ( $self, $flagsrequired ) = @_;
1176 return unless $self->userid;
1177 # TODO code from haspermission needs to be moved here!
1178 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1183 my $is_adult = $patron->is_adult
1185 Return true if the patron has a category with a type Adult (A) or Organization (I)
1191 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1196 my $is_child = $patron->is_child
1198 Return true if the patron has a category with a type Child (C)
1203 return $self->category->category_type eq 'C' ? 1 : 0;
1206 =head3 has_valid_userid
1208 my $patron = Koha::Patrons->find(42);
1209 $patron->userid( $new_userid );
1210 my $has_a_valid_userid = $patron->has_valid_userid
1212 my $patron = Koha::Patron->new( $params );
1213 my $has_a_valid_userid = $patron->has_valid_userid
1215 Return true if the current userid of this patron is valid/unique, otherwise false.
1217 Note that this should be done in $self->store instead and raise an exception if needed.
1221 sub has_valid_userid {
1224 return 0 unless $self->userid;
1226 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1228 my $already_exists = Koha::Patrons->search(
1230 userid => $self->userid,
1233 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1238 return $already_exists ? 0 : 1;
1241 =head3 generate_userid
1243 my $patron = Koha::Patron->new( $params );
1244 $patron->generate_userid
1246 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1248 Set a generated userid ($firstname.$surname if there is a $firstname, or $surname if there is no value in $firstname) plus offset (0 if the $userid is unique, or a higher numeric value if not unique).
1252 sub generate_userid {
1255 my $firstname = $self->firstname // q{};
1256 my $surname = $self->surname // q{};
1257 #The script will "do" the following code and increment the $offset until the generated userid is unique
1259 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1260 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1261 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1262 $userid = unac_string('utf-8',$userid);
1263 $userid .= $offset unless $offset == 0;
1264 $self->userid( $userid );
1266 } while (! $self->has_valid_userid );
1272 =head2 Internal methods
1284 Kyle M Hall <kyle@bywatersolutions.com>
1285 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>