use C4::Context;
use String::Random qw( random_string );
use Scalar::Util qw( looks_like_number );
-use Date::Calc qw/Today Add_Delta_YM check_date Date_to_Days/;
+use Date::Calc qw/Today check_date Date_to_Days/;
use C4::Log; # logaction
use C4::Overdues;
use C4::Reserves;
use Koha::Holds;
use Koha::List::Patron;
use Koha::Patrons;
+use Koha::Patron::Categories;
+use Koha::Schema;
our (@ISA,@EXPORT,@EXPORT_OK,$debug);
@ISA = qw(Exporter);
#Get data
push @EXPORT, qw(
- &Search
&GetMemberDetails
&GetMember
&GetFirstValidEmailAddress
&GetNoticeEmailAddress
- &GetAge
- &GetSortDetails
-
- &GetHideLostItemsPreference
-
- &IsMemberBlocked
&GetMemberAccountRecords
&GetBorNotifyAcctRecord
- &GetborCatFromCatType
- GetBorrowerCategorycode
-
&GetBorrowersToExpunge
&GetBorrowersWhoHaveNeverBorrowed
&GetBorrowersWithIssuesHistoryOlderThan
- &GetExpiryDate
&GetUpcomingMembershipExpires
&IssueSlip
GetBorrowersWithEmail
- HasOverdues
GetOverduesForPatron
);
&changepassword
);
- #Delete data
- push @EXPORT, qw(
- &DelMember
- );
-
#Insert data
push @EXPORT, qw(
&AddMember
&AddMember_Opac
- &MoveMemberToDeleted
- &ExtendMemberSubscriptionTo
);
#Check data
SELECT borrowers.*,
category_type,
categories.description,
- categories.BlockExpiredPatronOpacActions,
reservefee,
enrolmentperiod
FROM borrowers
SELECT borrowers.*,
category_type,
categories.description,
- categories.BlockExpiredPatronOpacActions,
reservefee,
enrolmentperiod
FROM borrowers
$borrower->{'flags'} = $flags;
$borrower->{'authflags'} = $accessflagshash;
- # Handle setting the true behavior for BlockExpiredPatronOpacActions
- $borrower->{'BlockExpiredPatronOpacActions'} =
- C4::Context->preference('BlockExpiredPatronOpacActions')
- if ( $borrower->{'BlockExpiredPatronOpacActions'} == -1 );
-
$borrower->{'is_expired'} = 0;
$borrower->{'is_expired'} = 1 if
defined($borrower->{dateexpiry}) &&
return;
}
-=head2 IsMemberBlocked
-
- my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
-
-Returns whether a patron is restricted or has overdue items that may result
-in a block of circulation privileges.
-
-C<$block_status> can have the following values:
-
-1 if the patron is currently restricted, in which case
-C<$count> is the expiration date (9999-12-31 for indefinite)
-
--1 if the patron has overdue items, in which case C<$count> is the number of them
-
-0 if the patron has no overdue items or outstanding fine days, in which case C<$count> is 0
-
-Existing active restrictions are checked before current overdue items.
-
-=cut
-
-sub IsMemberBlocked {
- my $borrowernumber = shift;
- my $dbh = C4::Context->dbh;
-
- my $blockeddate = Koha::Patrons->find( $borrowernumber )->is_debarred;
-
- return ( 1, $blockeddate ) if $blockeddate;
-
- # if he have late issues
- my $sth = $dbh->prepare(
- "SELECT COUNT(*) as latedocs
- FROM issues
- WHERE borrowernumber = ?
- AND date_due < now()"
- );
- $sth->execute($borrowernumber);
- my $latedocs = $sth->fetchrow_hashref->{'latedocs'};
-
- return ( -1, $latedocs ) if $latedocs > 0;
-
- return ( 0, 0 );
-}
-
=head2 GetMemberIssuesAndFines
($overdue_count, $issue_count, $total_fines) = &GetMemberIssuesAndFines($borrowernumber);
}
}
- my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
+ my $old_categorycode = Koha::Patrons->find( $data{borrowernumber} )->categorycode;
# get only the columns of a borrower
my $schema = Koha::Database->new()->schema;
$new_borrower->{dateexpiry} ||= undef if exists $new_borrower->{dateexpiry};
$new_borrower->{debarred} ||= undef if exists $new_borrower->{debarred};
$new_borrower->{sms_provider_id} ||= undef if exists $new_borrower->{sms_provider_id};
+ $new_borrower->{guarantorid} ||= undef if exists $new_borrower->{guarantorid};
- my $rs = $schema->resultset('Borrower')->search({
- borrowernumber => $new_borrower->{borrowernumber},
- });
+ my $patron = Koha::Patrons->find( $new_borrower->{borrowernumber} );
delete $new_borrower->{userid} if exists $new_borrower->{userid} and not $new_borrower->{userid};
- my $execute_success = $rs->update($new_borrower);
- if ($execute_success ne '0E0') { # only proceed if the update was a success
+ my $execute_success = $patron->store if $patron->set($new_borrower);
+
+ if ($execute_success) { # only proceed if the update was a success
# If the patron changes to a category with enrollment fee, we add a fee
if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
if ( C4::Context->preference('FeeOnChangePatronCategory') ) {
- AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
+ $patron->add_enrolment_fee_if_needed;
}
}
if ( $data{'userid'} eq '' || !Check_Userid( $data{'userid'} ) );
# add expiration date if it isn't already there
- unless ( $data{'dateexpiry'} ) {
- $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } ) );
- }
+ $data{dateexpiry} ||= Koha::Patron::Categories->find( $data{categorycode} )->get_expiry_date;
# add enrollment date if it isn't already there
unless ( $data{'dateenrolled'} ) {
$data{'sms_provider_id'} = undef if ( not $data{'sms_provider_id'} );
# get only the columns of Borrower
+ # FIXME Do we really need this check?
my @columns = $schema->source('Borrower')->columns;
my $new_member = { map { join(' ',@columns) =~ /$_/ ? ( $_ => $data{$_} ) : () } keys(%data) } ;
- $new_member->{checkprevcheckout} ||= 'inherit';
+
delete $new_member->{borrowernumber};
- my $rs = $schema->resultset('Borrower');
- $data{borrowernumber} = $rs->create($new_member)->id;
+ my $patron = Koha::Patron->new( $new_member )->store;
+ $data{borrowernumber} = $patron->borrowernumber;
# If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
# cronjob will use for syncing with NL
});
}
- # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
- AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
+ $patron->add_enrolment_fee_if_needed;
return $data{borrowernumber};
}
}
}
+ my $borrower = Koha::Schema->resultset('Borrower');
+ my $field_size = $borrower->result_source->column_info('cardnumber')->{size};
+ $min = $field_size if $min > $field_size;
return ( $min, $max );
}
return $data->{'primaryemail'} || '';
}
-=head2 GetExpiryDate
-
- $expirydate = GetExpiryDate($categorycode, $dateenrolled);
-
-Calculate expiry date given a categorycode and starting date. Date argument must be in ISO format.
-Return date is also in ISO format.
-
-=cut
-
-sub GetExpiryDate {
- my ( $categorycode, $dateenrolled ) = @_;
- my $enrolments;
- if ($categorycode) {
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("SELECT enrolmentperiod,enrolmentperioddate FROM categories WHERE categorycode=?");
- $sth->execute($categorycode);
- $enrolments = $sth->fetchrow_hashref;
- }
- # die "GetExpiryDate: for enrollmentperiod $enrolmentperiod (category '$categorycode') starting $dateenrolled.\n";
- my @date = split (/-/,$dateenrolled);
- if($enrolments->{enrolmentperiod}){
- return sprintf("%04d-%02d-%02d", Add_Delta_YM(@date,0,$enrolments->{enrolmentperiod}));
- }else{
- return $enrolments->{enrolmentperioddate};
- }
-}
-
=head2 GetUpcomingMembershipExpires
my $expires = GetUpcomingMembershipExpires({
return $results;
}
-=head2 GetborCatFromCatType
-
- ($codes_arrayref, $labels_hashref) = &GetborCatFromCatType();
-
-Looks up the different types of borrowers in the database. Returns two
-elements: a reference-to-array, which lists the borrower category
-codes, and a reference-to-hash, which maps the borrower category codes
-to category descriptions.
-
-=cut
-
-#'
-sub GetborCatFromCatType {
- my ( $category_type, $action, $no_branch_limit ) = @_;
-
- my $branch_limit = $no_branch_limit
- ? 0
- : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
-
- # FIXME - This API seems both limited and dangerous.
- my $dbh = C4::Context->dbh;
-
- my $request = qq{
- SELECT DISTINCT categories.categorycode, categories.description
- FROM categories
- };
- $request .= qq{
- LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
- } if $branch_limit;
- if($action) {
- $request .= " $action ";
- $request .= " AND (branchcode = ? OR branchcode IS NULL)" if $branch_limit;
- } else {
- $request .= " WHERE branchcode = ? OR branchcode IS NULL" if $branch_limit;
- }
- $request .= " ORDER BY categorycode";
-
- my $sth = $dbh->prepare($request);
- $sth->execute(
- $action ? $category_type : (),
- $branch_limit ? $branch_limit : ()
- );
-
- my %labels;
- my @codes;
-
- while ( my $data = $sth->fetchrow_hashref ) {
- push @codes, $data->{'categorycode'};
- $labels{ $data->{'categorycode'} } = $data->{'description'};
- }
- $sth->finish;
- return ( \@codes, \%labels );
-}
-
-=head2 GetBorrowerCategorycode
-
- $categorycode = &GetBorrowerCategoryCode( $borrowernumber );
-
-Given the borrowernumber, the function returns the corresponding categorycode
-
-=cut
-
-sub GetBorrowerCategorycode {
- my ( $borrowernumber ) = @_;
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare( qq{
- SELECT categorycode
- FROM borrowers
- WHERE borrowernumber = ?
- } );
- $sth->execute( $borrowernumber );
- return $sth->fetchrow;
-}
-
-=head2 GetAge
-
- $dateofbirth,$date = &GetAge($date);
-
-this function return the borrowers age with the value of dateofbirth
-
-=cut
-
-#'
-sub GetAge{
- my ( $date, $date_ref ) = @_;
-
- if ( not defined $date_ref ) {
- $date_ref = sprintf( '%04d-%02d-%02d', Today() );
- }
-
- my ( $year1, $month1, $day1 ) = split /-/, $date;
- my ( $year2, $month2, $day2 ) = split /-/, $date_ref;
-
- my $age = $year2 - $year1;
- if ( $month1 . $day1 > $month2 . $day2 ) {
- $age--;
- }
-
- return $age;
-} # sub get_age
-
-=head2 SetAge
-
- $borrower = C4::Members::SetAge($borrower, $datetimeduration);
- $borrower = C4::Members::SetAge($borrower, '0015-12-10');
- $borrower = C4::Members::SetAge($borrower, $datetimeduration, $datetime_reference);
-
- eval { $borrower = C4::Members::SetAge($borrower, '015-1-10'); };
- if ($@) {print $@;} #Catch a bad ISO Date or kill your script!
-
-This function sets the borrower's dateofbirth to match the given age.
-Optionally relative to the given $datetime_reference.
-
-@PARAM1 koha.borrowers-object
-@PARAM2 DateTime::Duration-object as the desired age
- OR a ISO 8601 Date. (To make the API more pleasant)
-@PARAM3 DateTime-object as the relative date, defaults to now().
-RETURNS The given borrower reference @PARAM1.
-DIES If there was an error with the ISO Date handling.
-
-=cut
-
-#'
-sub SetAge{
- my ( $borrower, $datetimeduration, $datetime_ref ) = @_;
- $datetime_ref = DateTime->now() unless $datetime_ref;
-
- if ($datetimeduration && ref $datetimeduration ne 'DateTime::Duration') {
- if ($datetimeduration =~ /^(\d{4})-(\d{2})-(\d{2})/) {
- $datetimeduration = DateTime::Duration->new(years => $1, months => $2, days => $3);
- }
- else {
- die "C4::Members::SetAge($borrower, $datetimeduration), datetimeduration not a valid ISO 8601 Date!\n";
- }
- }
-
- my $new_datetime_ref = $datetime_ref->clone();
- $new_datetime_ref->subtract_duration( $datetimeduration );
-
- $borrower->{dateofbirth} = $new_datetime_ref->ymd();
-
- return $borrower;
-} # sub SetAge
-
-=head2 GetSortDetails (OUEST-PROVENCE)
-
- ($lib) = &GetSortDetails($category,$sortvalue);
-
-Returns the authorized value details
-C<&$lib>return value of authorized value details
-C<&$sortvalue>this is the value of authorized value
-C<&$category>this is the value of authorized value category
-
-=cut
-
-sub GetSortDetails {
- my ( $category, $sortvalue ) = @_;
- my $dbh = C4::Context->dbh;
- my $query = qq|SELECT lib
- FROM authorised_values
- WHERE category=?
- AND authorised_value=? |;
- my $sth = $dbh->prepare($query);
- $sth->execute( $category, $sortvalue );
- my $lib = $sth->fetchrow;
- return ($lib) if ($lib);
- return ($sortvalue) unless ($lib);
-}
-
-=head2 MoveMemberToDeleted
-
- $result = &MoveMemberToDeleted($borrowernumber);
-
-Copy the record from borrowers to deletedborrowers table.
-The routine returns 1 for success, undef for failure.
-
-=cut
-
-sub MoveMemberToDeleted {
- my ($member) = shift or return;
-
- my $schema = Koha::Database->new()->schema();
- my $borrowers_rs = $schema->resultset('Borrower');
- $borrowers_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
- my $borrower = $borrowers_rs->find($member);
- return unless $borrower;
-
- my $deleted = $schema->resultset('Deletedborrower')->create($borrower);
-
- return $deleted ? 1 : undef;
-}
-
-=head2 DelMember
-
- DelMember($borrowernumber);
-
-This function remove directly a borrower whitout writing it on deleteborrower.
-+ Deletes reserves for the borrower
-
-=cut
-
-sub DelMember {
- my $dbh = C4::Context->dbh;
- my $borrowernumber = shift;
- #warn "in delmember with $borrowernumber";
- return unless $borrowernumber; # borrowernumber is mandatory.
- # Delete Patron's holds
- my @holds = Koha::Holds->search({ borrowernumber => $borrowernumber });
- $_->delete for @holds;
-
- my $query = "
- DELETE
- FROM borrowers
- WHERE borrowernumber = ?
- ";
- my $sth = $dbh->prepare($query);
- $sth->execute($borrowernumber);
- logaction("MEMBERS", "DELETE", $borrowernumber, "") if C4::Context->preference("BorrowersLog");
- return $sth->rows;
-}
-
-=head2 HandleDelBorrower
-
- HandleDelBorrower($borrower);
-
-When a member is deleted (DelMember in Members.pm), you should call me first.
-This routine deletes/moves lists and entries for the deleted member/borrower.
-Lists owned by the borrower are deleted, but entries from the borrower to
-other lists are kept.
-
-=cut
-
-sub HandleDelBorrower {
- my ($borrower)= @_;
- my $query;
- my $dbh = C4::Context->dbh;
-
- #Delete all lists and all shares of this borrower
- #Consistent with the approach Koha uses on deleting individual lists
- #Note that entries in virtualshelfcontents added by this borrower to
- #lists of others will be handled by a table constraint: the borrower
- #is set to NULL in those entries.
- $query="DELETE FROM virtualshelves WHERE owner=?";
- $dbh->do($query,undef,($borrower));
-
- #NOTE:
- #We could handle the above deletes via a constraint too.
- #But a new BZ report 11889 has been opened to discuss another approach.
- #Instead of deleting we could also disown lists (based on a pref).
- #In that way we could save shared and public lists.
- #The current table constraints support that idea now.
- #This pref should then govern the results of other routines/methods such as
- #Koha::Virtualshelf->new->delete too.
-}
-
-=head2 ExtendMemberSubscriptionTo (OUEST-PROVENCE)
-
- $date = ExtendMemberSubscriptionTo($borrowerid, $date);
-
-Extending the subscription to a given date or to the expiry date calculated on ISO date.
-Returns ISO date.
-
-=cut
-
-sub ExtendMemberSubscriptionTo {
- my ( $borrowerid,$date) = @_;
- my $dbh = C4::Context->dbh;
- my $borrower = GetMember('borrowernumber'=>$borrowerid);
- unless ($date){
- $date = (C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry') ?
- eval { output_pref( { dt => dt_from_string( $borrower->{'dateexpiry'} ), dateonly => 1, dateformat => 'iso' } ); }
- :
- output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' } );
- $date = GetExpiryDate( $borrower->{'categorycode'}, $date );
- }
- my $sth = $dbh->do(<<EOF);
-UPDATE borrowers
-SET dateexpiry='$date'
-WHERE borrowernumber='$borrowerid'
-EOF
-
- AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
-
- logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
- return $date if ($sth);
- return 0;
-}
-
-=head2 GetHideLostItemsPreference
-
- $hidelostitemspref = &GetHideLostItemsPreference($borrowernumber);
-
-Returns the HideLostItems preference for the patron category of the supplied borrowernumber
-C<&$hidelostitemspref>return value of function, 0 or 1
-
-=cut
-
-sub GetHideLostItemsPreference {
- my ($borrowernumber) = @_;
- my $dbh = C4::Context->dbh;
- my $query = "SELECT hidelostitems FROM borrowers,categories WHERE borrowers.categorycode = categories.categorycode AND borrowernumber = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($borrowernumber);
- my $hidelostitems = $sth->fetchrow;
- return $hidelostitems;
-}
-
=head2 GetBorrowersToExpunge
$borrowers = &GetBorrowersToExpunge(
my $params = shift;
my $filterdate = $params->{'not_borrowed_since'};
my $filterexpiry = $params->{'expired_before'};
+ my $filterlastseen = $params->{'last_seen'};
my $filtercategory = $params->{'category_code'};
my $filterbranch = $params->{'branchcode'} ||
((C4::Context->preference('IndependentBranches')
$query .= " AND dateexpiry < ? ";
push( @query_params, $filterexpiry );
}
+ if ( $filterlastseen ) {
+ $query .= ' AND lastseen < ? ';
+ push @query_params, $filterlastseen;
+ }
if ( $filtercategory ) {
$query .= " AND categorycode = ? ";
push( @query_params, $filtercategory );
return ( $borrowernumber, $borrower{'password'} );
}
-=head2 AddEnrolmentFeeIfNeeded
-
- AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
-
-Add enrolment fee for a patron if needed.
-
-=cut
-
-sub AddEnrolmentFeeIfNeeded {
- my ( $categorycode, $borrowernumber ) = @_;
- # check for enrollment fee & add it if needed
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare(q{
- SELECT enrolmentfee
- FROM categories
- WHERE categorycode=?
- });
- $sth->execute( $categorycode );
- if ( $sth->err ) {
- warn sprintf('Database returned the following error: %s', $sth->errstr);
- return;
- }
- my ($enrolmentfee) = $sth->fetchrow;
- if ($enrolmentfee && $enrolmentfee > 0) {
- # insert fee in patron debts
- C4::Accounts::manualinvoice( $borrowernumber, '', '', 'A', $enrolmentfee );
- }
-}
-
-=head2 HasOverdues
-
-=cut
-
-sub HasOverdues {
- my ( $borrowernumber ) = @_;
-
- my $sql = "SELECT COUNT(*) FROM issues WHERE date_due < NOW() AND borrowernumber = ?";
- my $sth = C4::Context->dbh->prepare( $sql );
- $sth->execute( $borrowernumber );
- my ( $count ) = $sth->fetchrow_array();
-
- return $count;
-}
-
=head2 DeleteExpiredOpacRegistrations
Delete accounts that haven't been upgraded from the 'temporary' category
$sth->execute( $category_code, $delay );
my $cnt=0;
while ( my ($borrowernumber) = $sth->fetchrow_array() ) {
- DelMember($borrowernumber);
+ Koha::Patrons->find($borrowernumber)->delete;
$cnt++;
}
return $cnt;