use C4::Context;
use C4::Dates qw(format_date_in_iso format_date);
use Digest::MD5 qw(md5_base64);
+use String::Random qw( random_string );
use Date::Calc qw/Today Add_Delta_YM check_date Date_to_Days/;
use C4::Log; # logaction
use C4::Overdues;
&getidcity
&GetFirstValidEmailAddress
+ &GetNoticeEmailAddress
&GetAge
&GetCities
GetBorrowerCategorycode
&GetBorrowercategoryList
- &GetBorrowersWhoHaveNotBorrowedSince
+ &GetBorrowersToExpunge
&GetBorrowersWhoHaveNeverBorrowed
&GetBorrowersWithIssuesHistoryOlderThan
#Insert data
push @EXPORT, qw(
&AddMember
+ &AddMember_Opac
&add_member_orgs
&MoveMemberToDeleted
&ExtendMemberSubscriptionTo
# $showallbranches was not used at the time SearchMember() was mainstreamed into Search().
# Mentioning for the reference
- if ( C4::Context->preference("IndependantBranches") ) { # && !$showallbranches){
+ if ( C4::Context->preference("IndependentBranches") ) { # && !$showallbranches){
if ( my $userenv = C4::Context->userenv ) {
my $branch = $userenv->{'branch'};
- if ( ($userenv->{flags} % 2 !=1) &&
- $branch && $branch ne "insecure" ){
-
+ if ( ($userenv->{flags} % 2 !=1) && $branch ){
if (my $fr = ref $filter) {
if ( $fr eq "HASH" ) {
$filter->{branchcode} = $branch;
my %flags;
my ( $patroninformation) = @_;
my $dbh=C4::Context->dbh;
- my ($amount) = GetMemberAccountRecords( $patroninformation->{'borrowernumber'});
- if ( $amount > 0 ) {
+ my ($balance, $owing) = GetMemberAccountBalance( $patroninformation->{'borrowernumber'});
+ if ( $owing > 0 ) {
my %flaginfo;
my $noissuescharge = C4::Context->preference("noissuescharge") || 5;
- $flaginfo{'message'} = sprintf "Patron owes \$%.02f", $amount;
- $flaginfo{'amount'} = sprintf "%.02f", $amount;
- if ( $amount > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
+ $flaginfo{'message'} = sprintf 'Patron owes %.02f', $owing;
+ $flaginfo{'amount'} = sprintf "%.02f", $owing;
+ if ( $owing > $noissuescharge && !C4::Context->preference("AllowFineOverride") ) {
$flaginfo{'noissues'} = 1;
}
$flags{'CHARGES'} = \%flaginfo;
}
- elsif ( $amount < 0 ) {
+ elsif ( $balance < 0 ) {
my %flaginfo;
- $flaginfo{'message'} = sprintf "Patron has credit of \$%.02f", -$amount;
- $flaginfo{'amount'} = sprintf "%.02f", $amount;
+ $flaginfo{'message'} = sprintf 'Patron has credit of %.02f', -$balance;
+ $flaginfo{'amount'} = sprintf "%.02f", $balance;
$flags{'CREDITS'} = \%flaginfo;
}
if ( $patroninformation->{'gonenoaddress'}
return ($overdue_count, $issue_count, $total_fines);
}
-sub columns(;$) {
- return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
+
+=head2 columns
+
+ my @columns = C4::Member::columns();
+
+Returns an array of borrowers' table columns on success,
+and an empty array on failure.
+
+=cut
+
+sub columns {
+
+ # Pure ANSI SQL goodness.
+ my $sql = 'SELECT * FROM borrowers WHERE 1=0;';
+
+ # Get the database handle.
+ my $dbh = C4::Context->dbh;
+
+ # Run the SQL statement to load STH's readonly properties.
+ my $sth = $dbh->prepare($sql);
+ my $rv = $sth->execute();
+
+ # This only fails if the table doesn't exist.
+ # This will always be called AFTER an install or upgrade,
+ # so borrowers will exist!
+ my @data;
+ if ($sth->{NUM_OF_FIELDS}>0) {
+ @data = @{$sth->{NAME}};
+ }
+ else {
+ @data = ();
+ }
+ return @data;
}
+
=head2 ModMember
my $success = ModMember(borrowernumber => $borrowernumber,
$data{password} = md5_base64($data{password});
}
}
+ my $old_categorycode = GetBorrowerCategorycode( $data{borrowernumber} );
my $execute_success=UpdateInTable("borrowers",\%data);
if ($execute_success) { # only proceed if the update was a success
# ok if its an adult (type) it may have borrowers that depend on it as a guarantor
# is adult check guarantees;
UpdateGuarantees(%data);
}
+
+ # If the patron changes to a category with enrollment fee, we add a fee
+ if ( $data{categorycode} and $data{categorycode} ne $old_categorycode ) {
+ AddEnrolmentFeeIfNeeded( $data{categorycode}, $data{borrowernumber} );
+ }
+
logaction("MEMBERS", "MODIFY", $data{'borrowernumber'}, "UPDATE (executed w/ arg: $data{'borrowernumber'})") if C4::Context->preference("BorrowersLog");
}
return $execute_success;
}
-
=head2 AddMember
$borrowernumber = &AddMember(%borrower);
sub AddMember {
my (%data) = @_;
my $dbh = C4::Context->dbh;
- # generate a proper login if none provided
- $data{'userid'} = Generate_Userid($data{'borrowernumber'}, $data{'firstname'}, $data{'surname'}) if $data{'userid'} eq '';
- # create a disabled account if no password provided
- $data{'password'} = ($data{'password'})? md5_base64($data{'password'}) : '!';
- $data{'borrowernumber'}=InsertInTable("borrowers",\%data);
- # mysql_insertid is probably bad. not necessarily accurate and mysql-specific at best.
- logaction("MEMBERS", "CREATE", $data{'borrowernumber'}, "") if C4::Context->preference("BorrowersLog");
-
- # check for enrollment fee & add it if needed
- my $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
- $sth->execute($data{'categorycode'});
- my ($enrolmentfee) = $sth->fetchrow;
- if ($sth->err) {
- warn sprintf('Database returned the following error: %s', $sth->errstr);
- return;
+
+ # generate a proper login if none provided
+ $data{'userid'} = Generate_Userid($data{'borrowernumber'}, $data{'firstname'}, $data{'surname'}) if $data{'userid'} eq '';
+
+ # add expiration date if it isn't already there
+ unless ( $data{'dateexpiry'} ) {
+ $data{'dateexpiry'} = GetExpiryDate( $data{'categorycode'}, C4::Dates->new()->output("iso") );
}
- if ($enrolmentfee && $enrolmentfee > 0) {
- # insert fee in patron debts
- manualinvoice($data{'borrowernumber'}, '', '', 'A', $enrolmentfee);
+
+ # add enrollment date if it isn't already there
+ unless ( $data{'dateenrolled'} ) {
+ $data{'dateenrolled'} = C4::Dates->new()->output("iso");
}
+ # create a disabled account if no password provided
+ $data{'password'} = ($data{'password'})? md5_base64($data{'password'}) : '!';
+ $data{'borrowernumber'}=InsertInTable("borrowers",\%data);
+
+
+ # 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} );
+
return $data{'borrowernumber'};
}
+=head2 Check_Userid
+
+ my $uniqueness = Check_Userid($userid,$borrowernumber);
+
+ $borrowernumber is optional (i.e. it can contain a blank value). If $userid is passed with a blank $borrowernumber variable, the database will be checked for all instances of that userid (i.e. userid=? AND borrowernumber != '').
+
+ If $borrowernumber is provided, the database will be checked for every instance of that userid coupled with a different borrower(number) than the one provided.
+
+ return :
+ 0 for not unique (i.e. this $userid already exists)
+ 1 for unique (i.e. this $userid does not exist, or this $userid/$borrowernumber combination already exists)
+
+=cut
sub Check_Userid {
my ($uid,$member) = @_;
my $dbh = C4::Context->dbh;
- # Make sure the userid chosen is unique and not theirs if non-empty. If it is not,
- # Then we need to tell the user and have them create a new one.
my $sth =
$dbh->prepare(
"SELECT * FROM borrowers WHERE userid=? AND borrowernumber != ?");
}
}
+=head2 Generate_Userid
+
+ my $newuid = Generate_Userid($borrowernumber, $firstname, $surname);
+
+ Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
+
+ $borrowernumber is optional (i.e. it can contain a blank value). A value is passed when generating a new userid for an existing borrower. When a new userid is created for a new borrower, a blank value is passed to this sub.
+
+ return :
+ new userid ($firstname.$surname if there is a $firstname, or $surname if there is no value in $firstname) plus offset (0 if the $newuid is unique, or a higher numeric value if Check_Userid finds an existing match for the $newuid in the database).
+
+=cut
+
sub Generate_Userid {
my ($borrowernumber, $firstname, $surname) = @_;
my $newuid;
my $offset = 0;
+ #The script will "do" the following code and increment the $offset until Check_Userid = 1 (i.e. until $newuid comes back as unique)
do {
$firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
$surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
=cut
-#'
sub GetMemberAccountRecords {
- my ($borrowernumber,$date) = @_;
+ my ($borrowernumber) = @_;
my $dbh = C4::Context->dbh;
my @acctlines;
my $numlines = 0;
SELECT *
FROM accountlines
WHERE borrowernumber=?);
- my @bind = ($borrowernumber);
- if ($date && $date ne ''){
- $strsth.=" AND date < ? ";
- push(@bind,$date);
- }
$strsth.=" ORDER BY date desc,timestamp DESC";
my $sth= $dbh->prepare( $strsth );
- $sth->execute( @bind );
+ $sth->execute( $borrowernumber );
+
my $total = 0;
while ( my $data = $sth->fetchrow_hashref ) {
if ( $data->{itemnumber} ) {
return ( $total, \@acctlines,$numlines);
}
+=head2 GetMemberAccountBalance
+
+ ($total_balance, $non_issue_balance, $other_charges) = &GetMemberAccountBalance($borrowernumber);
+
+Calculates amount immediately owing by the patron - non-issue charges.
+Based on GetMemberAccountRecords.
+Charges exempt from non-issue are:
+* Res (reserves)
+* Rent (rental) if RentalsInNoissuesCharge syspref is set to false
+* Manual invoices if ManInvInNoissuesCharge syspref is set to false
+
+=cut
+
+sub GetMemberAccountBalance {
+ my ($borrowernumber) = @_;
+
+ my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
+
+ my @not_fines = ('Res');
+ push @not_fines, 'Rent' unless C4::Context->preference('RentalsInNoissuesCharge');
+ unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
+ my $dbh = C4::Context->dbh;
+ my $man_inv_types = $dbh->selectcol_arrayref(qq{SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'});
+ push @not_fines, map substr($_, 0, $ACCOUNT_TYPE_LENGTH), @$man_inv_types;
+ }
+ my %not_fine = map {$_ => 1} @not_fines;
+
+ my ($total, $acctlines) = GetMemberAccountRecords($borrowernumber);
+ my $other_charges = 0;
+ foreach (@$acctlines) {
+ $other_charges += $_->{amountoutstanding} if $not_fine{ substr($_->{accounttype}, 0, $ACCOUNT_TYPE_LENGTH) };
+ }
+
+ return ( $total, $total - $other_charges, $other_charges);
+}
+
=head2 GetBorNotifyAcctRecord
($total, $acctlines, $count) = &GetBorNotifyAcctRecord($params,$notifyid);
}
}
+=head2 GetNoticeEmailAddress
+
+ $email = GetNoticeEmailAddress($borrowernumber);
+
+Return the email address of borrower used for notices, given the borrowernumber.
+Returns the empty string if no email address.
+
+=cut
+
+sub GetNoticeEmailAddress {
+ my $borrowernumber = shift;
+
+ my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
+ # if syspref is set to 'first valid' (value == OFF), look up email address
+ if ( $which_address eq 'OFF' ) {
+ return GetFirstValidEmailAddress($borrowernumber);
+ }
+ # specified email address field
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare( qq{
+ SELECT $which_address AS primaryemail
+ FROM borrowers
+ WHERE borrowernumber=?
+ } );
+ $sth->execute($borrowernumber);
+ my $data = $sth->fetchrow_hashref;
+ return $data->{'primaryemail'} || '';
+}
+
=head2 GetExpiryDate
$expirydate = GetExpiryDate($categorycode, $dateenrolled);
#'
sub GetborCatFromCatType {
- my ( $category_type, $action ) = @_;
- # FIXME - This API seems both limited and dangerous.
+ 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 categorycode,description
- FROM categories
- $action
- ORDER BY categorycode|;
- my $sth = $dbh->prepare($request);
- if ($action) {
- $sth->execute($category_type);
- }
- else {
- $sth->execute();
+
+ my $request = qq{
+ SELECT 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) GROUP BY description" if $branch_limit;
+ } else {
+ $request .= " WHERE branchcode = ? OR branchcode IS NULL GROUP BY description" 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;
push @codes, $data->{'categorycode'};
$labels{ $data->{'categorycode'} } = $data->{'description'};
}
+ $sth->finish;
return ( \@codes, \%labels );
}
=cut
sub GetBorrowercategoryList {
+ my $no_branch_limit = @_ ? shift : 0;
+ my $branch_limit = $no_branch_limit
+ ? 0
+ : C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
my $dbh = C4::Context->dbh;
- my $sth =
- $dbh->prepare(
- "SELECT *
- FROM categories
- ORDER BY description"
- );
- $sth->execute;
- my $data =
- $sth->fetchall_arrayref({});
+ my $query = "SELECT categories.* FROM categories";
+ $query .= qq{
+ LEFT JOIN categories_branches ON categories.categorycode = categories_branches.categorycode
+ WHERE branchcode = ? OR branchcode IS NULL GROUP BY description
+ } if $branch_limit;
+ $query .= " ORDER BY description";
+ my $sth = $dbh->prepare( $query );
+ $sth->execute( $branch_limit ? $branch_limit : () );
+ my $data = $sth->fetchall_arrayref( {} );
+ $sth->finish;
return $data;
} # sub getborrowercategory
SET dateexpiry='$date'
WHERE borrowernumber='$borrowerid'
EOF
- # add enrolmentfee if needed
- $sth = $dbh->prepare("SELECT enrolmentfee FROM categories WHERE categorycode=?");
- $sth->execute($borrower->{'categorycode'});
- my ($enrolmentfee) = $sth->fetchrow;
- if ($enrolmentfee && $enrolmentfee > 0) {
- # insert fee in patron debts
- manualinvoice($borrower->{'borrowernumber'}, '', '', 'A', $enrolmentfee);
- }
- logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
+
+ AddEnrolmentFeeIfNeeded( $borrower->{categorycode}, $borrower->{borrowernumber} );
+
+ logaction("MEMBERS", "RENEW", $borrower->{'borrowernumber'}, "Membership renewed")if C4::Context->preference("BorrowersLog");
return $date if ($sth);
return 0;
}
return ($roadtype);
}
-=head2 GetBorrowersWhoHaveNotBorrowedSince
+=head2 GetBorrowersToExpunge
- &GetBorrowersWhoHaveNotBorrowedSince($date)
+ $borrowers = &GetBorrowersToExpunge(
+ not_borrowered_since => $not_borrowered_since,
+ expired_before => $expired_before,
+ category_code => $category_code,
+ branchcode => $branchcode
+ );
-this function get all borrowers who haven't borrowed since the date given on input arg.
+ This function get all borrowers based on the given criteria.
=cut
-sub GetBorrowersWhoHaveNotBorrowedSince {
- my $filterdate = shift||POSIX::strftime("%Y-%m-%d",localtime());
- my $filterexpiry = shift;
- my $filterbranch = shift ||
- ((C4::Context->preference('IndependantBranches')
+sub GetBorrowersToExpunge {
+ my $params = shift;
+
+ my $filterdate = $params->{'not_borrowered_since'};
+ my $filterexpiry = $params->{'expired_before'};
+ my $filtercategory = $params->{'category_code'};
+ my $filterbranch = $params->{'branchcode'} ||
+ ((C4::Context->preference('IndependentBranches')
&& C4::Context->userenv
&& C4::Context->userenv->{flags} % 2 !=1
&& C4::Context->userenv->{branch})
? C4::Context->userenv->{branch}
: "");
+
my $dbh = C4::Context->dbh;
my $query = "
SELECT borrowers.borrowernumber,
- max(old_issues.timestamp) as latestissue,
- max(issues.timestamp) as currentissue
+ MAX(old_issues.timestamp) AS latestissue,
+ MAX(issues.timestamp) AS currentissue
FROM borrowers
JOIN categories USING (categorycode)
LEFT JOIN old_issues USING (borrowernumber)
LEFT JOIN issues USING (borrowernumber)
WHERE category_type <> 'S'
- AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
+ AND borrowernumber NOT IN (SELECT guarantorid FROM borrowers WHERE guarantorid IS NOT NULL AND guarantorid <> 0)
";
my @query_params;
- if ($filterbranch && $filterbranch ne ""){
- $query.=" AND borrowers.branchcode= ?";
- push @query_params,$filterbranch;
+ if ( $filterbranch && $filterbranch ne "" ) {
+ $query.= " AND borrowers.branchcode = ? ";
+ push( @query_params, $filterbranch );
}
- if($filterexpiry){
+ if ( $filterexpiry ) {
$query .= " AND dateexpiry < ? ";
- push @query_params,$filterdate;
+ push( @query_params, $filterexpiry );
}
- $query.=" GROUP BY borrowers.borrowernumber";
- if ($filterdate){
- $query.=" HAVING (latestissue < ? OR latestissue IS NULL)
- AND currentissue IS NULL";
+ if ( $filtercategory ) {
+ $query .= " AND categorycode = ? ";
+ push( @query_params, $filtercategory );
+ }
+ $query.=" GROUP BY borrowers.borrowernumber HAVING currentissue IS NULL ";
+ if ( $filterdate ) {
+ $query.=" AND ( latestissue < ? OR latestissue IS NULL ) ";
push @query_params,$filterdate;
}
warn $query if $debug;
+
my $sth = $dbh->prepare($query);
if (scalar(@query_params)>0){
$sth->execute(@query_params);
sub GetBorrowersWhoHaveNeverBorrowed {
my $filterbranch = shift ||
- ((C4::Context->preference('IndependantBranches')
+ ((C4::Context->preference('IndependentBranches')
&& C4::Context->userenv
&& C4::Context->userenv->{flags} % 2 !=1
&& C4::Context->userenv->{branch})
my $dbh = C4::Context->dbh;
my $date = shift ||POSIX::strftime("%Y-%m-%d",localtime());
my $filterbranch = shift ||
- ((C4::Context->preference('IndependantBranches')
+ ((C4::Context->preference('IndependentBranches')
&& C4::Context->userenv
&& C4::Context->userenv->{flags} % 2 !=1
&& C4::Context->userenv->{branch})
my $issueslist = GetPendingIssues($borrowernumber);
foreach my $it (@$issueslist){
- if ((substr $it->{'issuedate'}, 0, 10) eq $now) {
+ if ((substr $it->{'issuedate'}, 0, 10) eq $now || (substr $it->{'lastreneweddate'}, 0, 10) eq $now) {
$it->{'now'} = 1;
}
elsif ((substr $it->{'date_due'}, 0, 10) le $now) {
$it->{'overdue'} = 1;
}
-
- $it->{'date_due'}=format_date($it->{'date_due'});
+ my $dt = dt_from_string( $it->{'date_due'} );
+ $it->{'date_due'} = output_pref( $dt );;
}
my @issues = sort { $b->{'timestamp'} <=> $a->{'timestamp'} } @$issueslist;
return @result;
}
+sub AddMember_Opac {
+ my ( %borrower ) = @_;
+
+ $borrower{'categorycode'} = C4::Context->preference('PatronSelfRegistrationDefaultCategory');
+
+ my $sr = new String::Random;
+ $sr->{'A'} = [ 'A'..'Z', 'a'..'z' ];
+ my $password = $sr->randpattern("AAAAAAAAAA");
+ $borrower{'password'} = $password;
+
+ $borrower{'cardnumber'} = fixup_cardnumber();
+
+ my $borrowernumber = AddMember(%borrower);
+
+ return ( $borrowernumber, $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 );
+ }
+}
END { } # module clean-up code here (global destructor)