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.
32 use Koha
::Patron
::Categories
;
33 use Koha
::Patron
::HouseboundProfile
;
34 use Koha
::Patron
::HouseboundRole
;
35 use Koha
::Patron
::Images
;
37 use Koha
::Virtualshelves
;
39 use base
qw(Koha::Object);
43 Koha::Patron - Koha Patron Object class
55 Delete patron's holds, lists and finally the patron.
57 Lists owned by the borrower are deleted, but entries from the borrower to
66 $self->_result->result_source->schema->txn_do(
68 # Delete Patron's holds
69 # FIXME Should be $patron->get_holds
70 $_->delete for Koha
::Holds
->search( { borrowernumber
=> $self->borrowernumber } );
72 # Delete all lists and all shares of this borrower
73 # Consistent with the approach Koha uses on deleting individual lists
74 # Note that entries in virtualshelfcontents added by this borrower to
75 # lists of others will be handled by a table constraint: the borrower
76 # is set to NULL in those entries.
78 # We could handle the above deletes via a constraint too.
79 # But a new BZ report 11889 has been opened to discuss another approach.
80 # Instead of deleting we could also disown lists (based on a pref).
81 # In that way we could save shared and public lists.
82 # The current table constraints support that idea now.
83 # This pref should then govern the results of other routines/methods such as
84 # Koha::Virtualshelf->new->delete too.
85 # FIXME Could be $patron->get_lists
86 $_->delete for Koha
::Virtualshelves
->search( { owner
=> $self->borrowernumber } );
88 $deleted = $self->SUPER::delete;
90 logaction
( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4
::Context
->preference("BorrowersLog");
98 Returns a Koha::Patron object for this patron's guarantor
105 return unless $self->guarantorid();
107 return Koha
::Patrons
->find( $self->guarantorid() );
113 return Koha
::Patron
::Images
->find( $self->borrowernumber )
118 Returns the guarantees (list of Koha::Patron) of this patron
125 return Koha
::Patrons
->search( { guarantorid
=> $self->borrowernumber } );
128 =head3 housebound_profile
130 Returns the HouseboundProfile associated with this patron.
134 sub housebound_profile
{
136 my $profile = $self->_result->housebound_profile;
137 return Koha
::Patron
::HouseboundProfile
->_new_from_dbic($profile)
142 =head3 housebound_role
144 Returns the HouseboundRole associated with this patron.
148 sub housebound_role
{
151 my $role = $self->_result->housebound_role;
152 return Koha
::Patron
::HouseboundRole
->_new_from_dbic($role) if ( $role );
158 Returns the siblings of this patron.
165 my $guarantor = $self->guarantor;
167 return unless $guarantor;
169 return Koha
::Patrons
->search(
173 '=' => $guarantor->id,
176 '!=' => $self->borrowernumber,
182 =head3 wants_check_for_previous_checkout
184 $wants_check = $patron->wants_check_for_previous_checkout;
186 Return 1 if Koha needs to perform PrevIssue checking, else 0.
190 sub wants_check_for_previous_checkout
{
192 my $syspref = C4
::Context
->preference("checkPrevCheckout");
195 ## Hard syspref trumps all
196 return 1 if ($syspref eq 'hardyes');
197 return 0 if ($syspref eq 'hardno');
198 ## Now, patron pref trumps all
199 return 1 if ($self->checkprevcheckout eq 'yes');
200 return 0 if ($self->checkprevcheckout eq 'no');
202 # More complex: patron inherits -> determine category preference
203 my $checkPrevCheckoutByCat = Koha
::Patron
::Categories
204 ->find($self->categorycode)->checkprevcheckout;
205 return 1 if ($checkPrevCheckoutByCat eq 'yes');
206 return 0 if ($checkPrevCheckoutByCat eq 'no');
208 # Finally: category preference is inherit, default to 0
209 if ($syspref eq 'softyes') {
216 =head3 do_check_for_previous_checkout
218 $do_check = $patron->do_check_for_previous_checkout($item);
220 Return 1 if the bib associated with $ITEM has previously been checked out to
221 $PATRON, 0 otherwise.
225 sub do_check_for_previous_checkout
{
226 my ( $self, $item ) = @_;
228 # Find all items for bib and extract item numbers.
229 my @items = Koha
::Items
->search({biblionumber
=> $item->{biblionumber
}});
231 foreach my $item (@items) {
232 push @item_nos, $item->itemnumber;
235 # Create (old)issues search criteria
237 borrowernumber
=> $self->borrowernumber,
238 itemnumber
=> \
@item_nos,
241 # Check current issues table
242 my $issues = Koha
::Issues
->search($criteria);
243 return 1 if $issues->count; # 0 || N
245 # Check old issues table
246 my $old_issues = Koha
::OldIssues
->search($criteria);
247 return $old_issues->count; # 0 || N
252 my $debarment_expiration = $patron->is_debarred;
254 Returns the date a patron debarment will expire, or undef if the patron is not
262 return unless $self->debarred;
263 return $self->debarred
264 if $self->debarred =~ '^9999'
265 or dt_from_string
( $self->debarred ) > dt_from_string
;
269 =head2 update_password
271 my $updated = $patron->update_password( $userid, $password );
273 Update the userid and the password of a patron.
274 If the userid already exists, returns and let DBIx::Class warns
275 This will add an entry to action_logs if BorrowersLog is set.
279 sub update_password
{
280 my ( $self, $userid, $password ) = @_;
281 eval { $self->userid($userid)->store; };
282 return if $@
; # Make sure the userid is not already in used by another patron
283 $self->password($password)->store;
284 logaction
( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4
::Context
->preference("BorrowersLog");
290 my $new_expiry_date = $patron->renew_account
292 Extending the subscription to the expiry date.
300 C4
::Context
->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
301 ? dt_from_string
( $self->dateexpiry )
303 my $patron_category = Koha
::Patron
::Categories
->find( $self->categorycode ); # FIXME Should be $self->category
304 my $expiry_date = $patron_category->get_expiry_date($date);
306 $self->dateexpiry($expiry_date)->store;
308 C4
::Members
::AddEnrolmentFeeIfNeeded
( $self->categorycode, $self->borrowernumber );
310 logaction
( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4
::Context
->preference("BorrowersLog");
311 return dt_from_string
( $expiry_date )->truncate( to
=> 'day' );
316 my $has_overdues = $patron->has_overdues;
318 Returns the number of patron's overdues
324 my $dtf = Koha
::Database
->new->schema->storage->datetime_parser;
325 return $self->_result->issues->search({ date_due
=> { '<' => $dtf->format_datetime( dt_from_string
() ) } })->count;
330 $patron->track_login;
331 $patron->track_login({ force => 1 });
333 Tracks a (successful) login attempt.
334 The preference TrackLastPatronActivity must be enabled. Or you
335 should pass the force parameter.
340 my ( $self, $params ) = @_;
343 !C4
::Context
->preference('TrackLastPatronActivity');
344 $self->lastseen( dt_from_string
() )->store;
347 =head2 move_to_deleted
349 my $is_moved = $patron->move_to_deleted;
351 Move a patron to the deletedborrowers table.
352 This can be done before deleting a patron, to make sure the data are not completely deleted.
356 sub move_to_deleted
{
358 my $patron_infos = $self->unblessed;
359 return Koha
::Database
->new->schema->resultset('Deletedborrower')->create($patron_infos);
362 =head3 article_requests
364 my @requests = $borrower->article_requests();
365 my $requests = $borrower->article_requests();
367 Returns either a list of ArticleRequests objects,
368 or an ArtitleRequests object, depending on the
373 sub article_requests
{
376 $self->{_article_requests
} ||= Koha
::ArticleRequests
->search({ borrowernumber
=> $self->borrowernumber() });
378 return $self->{_article_requests
};
381 =head3 article_requests_current
383 my @requests = $patron->article_requests_current
385 Returns the article requests associated with this patron that are incomplete
389 sub article_requests_current
{
392 $self->{_article_requests_current
} ||= Koha
::ArticleRequests
->search(
394 borrowernumber
=> $self->id(),
396 { status
=> Koha
::ArticleRequest
::Status
::Pending
},
397 { status
=> Koha
::ArticleRequest
::Status
::Processing
}
402 return $self->{_article_requests_current
};
405 =head3 article_requests_finished
407 my @requests = $biblio->article_requests_finished
409 Returns the article requests associated with this patron that are completed
413 sub article_requests_finished
{
414 my ( $self, $borrower ) = @_;
416 $self->{_article_requests_finished
} ||= Koha
::ArticleRequests
->search(
418 borrowernumber
=> $self->id(),
420 { status
=> Koha
::ArticleRequest
::Status
::Completed
},
421 { status
=> Koha
::ArticleRequest
::Status
::Canceled
}
426 return $self->{_article_requests_finished
};
439 Kyle M Hall <kyle@bywatersolutions.com>
440 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>