Jonathan Druart
9d6d641d1f
On bug 17591 we discovered that there was something weird going on with the way we export and use subroutines/modules. This patch tries to standardize our EXPORT to use EXPORT_OK only. That way we will need to explicitely define the subroutine we want to use from a module. This patch is a squashed version of: Bug 17600: After export.pl Bug 17600: After perlimport Bug 17600: Manual changes Bug 17600: Other manual changes after second perlimports run Bug 17600: Fix tests And a lot of other manual changes. export.pl is a dirty script that can be found on bug 17600. "perlimport" is: git clone https://github.com/oalders/App-perlimports.git cd App-perlimports/ cpanm --installdeps . export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib" find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \; The ideas of this patch are to: * use EXPORT_OK instead of EXPORT * perltidy the EXPORT_OK list * remove '&' before the subroutine names * remove some uneeded use statements * explicitely import the subroutines we need within the controllers or modules Note that the private subroutines (starting with _) should not be exported (and not used from outside of the module except from tests). EXPORT vs EXPORT_OK (from https://www.thegeekstuff.com/2010/06/perl-exporter-examples/) """ Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members. @EXPORT and @EXPORT_OK are the two main variables used during export operation. @EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace. @EXPORT_OK does export of symbols on demand basis. """ If this patch caused a conflict with a patch you wrote prior to its push: * Make sure you are not reintroducing a "use" statement that has been removed * "$subroutine" is not exported by the C4::$MODULE module means that you need to add the subroutine to the @EXPORT_OK list * Bareword "$subroutine" not allowed while "strict subs" means that you didn't imported the subroutine from the module: - use $MODULE qw( $subroutine list ); You can also use the fully qualified namespace: C4::$MODULE::$subroutine Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
206 lines
5.5 KiB
Perl
Executable file
206 lines
5.5 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
# This file is part of Koha.
|
|
#
|
|
# Copyright (C) 2015 Amit Gupta (amitddng135@gmail.com)
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
=head1 NAME
|
|
|
|
membership_expiry.pl - cron script to put membership expiry reminders into the message queue
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
./membership_expiry.pl -c
|
|
|
|
or, in crontab:
|
|
|
|
0 1 * * * membership_expiry.pl -c
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This script sends membership expiry reminder notices to patrons.
|
|
It queues them in the message queue, which is processed by
|
|
the process_message_queue.pl cronjob.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 8
|
|
|
|
=item B<--help>
|
|
|
|
Print a brief help message and exits.
|
|
|
|
=item B<--man>
|
|
|
|
Prints the manual page and exits.
|
|
|
|
=item B<-v>
|
|
|
|
Verbose. Without this flag set, only fatal errors are reported.
|
|
|
|
=item B<-n>
|
|
|
|
Do not send any email. Membership expire notices that would have been sent to
|
|
the patrons are printed to standard out.
|
|
|
|
=item B<-c>
|
|
|
|
Confirm flag: Add this option. The script will only print a usage
|
|
statement otherwise.
|
|
|
|
=item B<-branch>
|
|
|
|
Optional branchcode to restrict the cronjob to that branch.
|
|
|
|
=item B<-before>
|
|
|
|
Optional parameter to extend the selection with a number of days BEFORE
|
|
the date set by the preference.
|
|
|
|
=item B<-after>
|
|
|
|
Optional parameter to extend the selection with a number of days AFTER
|
|
the date set by the preference.
|
|
|
|
=item B<-letter>
|
|
|
|
Optional parameter to use another notice than the default one.
|
|
|
|
=back
|
|
|
|
=head1 CONFIGURATION
|
|
|
|
The content of the messages is configured in Tools -> Notices and slips. Use the MEMBERSHIP_EXPIRY notice.
|
|
|
|
Typically, messages are prepared for each patron when the memberships are going to expire.
|
|
|
|
These emails are staged in the outgoing message queue, as are messages
|
|
produced by other features of Koha. This message queue must be
|
|
processed regularly by the
|
|
F<misc/cronjobs/process_message_queue.pl> program.
|
|
|
|
In the event that the C<-n> flag is passed to this program, no emails
|
|
are sent. Instead, messages are sent on standard output from this
|
|
program.
|
|
|
|
Notices can contain variables enclosed in double angle brackets like
|
|
E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
|
|
specific to the soon expiring members.
|
|
Available variables are:
|
|
|
|
=over
|
|
|
|
=item E<lt>E<lt>borrowers.*E<gt>E<gt>
|
|
|
|
any field from the borrowers table
|
|
|
|
=item E<lt>E<lt>branches.*E<gt>E<gt>
|
|
|
|
any field from the branches table
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
use Modern::Perl;
|
|
use Getopt::Long qw( GetOptions );
|
|
use Pod::Usage qw( pod2usage );
|
|
BEGIN {
|
|
# find Koha's Perl modules
|
|
# test carefully before changing this
|
|
use FindBin ();
|
|
eval { require "$FindBin::Bin/../kohalib.pl" };
|
|
}
|
|
|
|
use Koha::Script -cron;
|
|
use C4::Context;
|
|
use C4::Letters;
|
|
use C4::Log qw( cronlogaction );
|
|
|
|
use Koha::Patrons;
|
|
|
|
# These are defaults for command line options.
|
|
my $confirm; # -c: Confirm that the user has read and configured this script.
|
|
my $nomail; # -n: No mail. Will not send any emails.
|
|
my $verbose = 0; # -v: verbose
|
|
my $help = 0;
|
|
my $man = 0;
|
|
my $before = 0;
|
|
my $after = 0;
|
|
my ( $branch, $letter_type );
|
|
|
|
GetOptions(
|
|
'help|?' => \$help,
|
|
'man' => \$man,
|
|
'c' => \$confirm,
|
|
'n' => \$nomail,
|
|
'v' => \$verbose,
|
|
'branch:s' => \$branch,
|
|
'before:i' => \$before,
|
|
'after:i' => \$after,
|
|
'letter:s' => \$letter_type,
|
|
) or pod2usage(2);
|
|
|
|
pod2usage( -verbose => 2 ) if $man;
|
|
pod2usage(1) if $help || !$confirm;
|
|
|
|
cronlogaction();
|
|
|
|
my $expdays = C4::Context->preference('MembershipExpiryDaysNotice');
|
|
if( !$expdays ) {
|
|
#If the pref is not set, we will exit
|
|
warn 'Exiting membership_expiry.pl: MembershipExpiryDaysNotice not set'
|
|
if $verbose;
|
|
exit;
|
|
}
|
|
|
|
warn 'getting upcoming membership expires' if $verbose;
|
|
my $upcoming_mem_expires = Koha::Patrons->search_upcoming_membership_expires(
|
|
{
|
|
( $branch ? ( 'me.branchcode' => $branch ) : () ),
|
|
before => $before,
|
|
after => $after,
|
|
}
|
|
);
|
|
warn 'found ' . $upcoming_mem_expires->count . ' soon expiring members'
|
|
if $verbose;
|
|
|
|
# main loop
|
|
$letter_type = 'MEMBERSHIP_EXPIRY' if !$letter_type;
|
|
while ( my $recent = $upcoming_mem_expires->next ) {
|
|
my $from_address = $recent->library->from_email_address;
|
|
my $letter = C4::Letters::GetPreparedLetter(
|
|
module => 'members',
|
|
letter_code => $letter_type,
|
|
branchcode => $recent->branchcode,
|
|
lang => $recent->lang,
|
|
tables => {
|
|
borrowers => $recent->borrowernumber,
|
|
branches => $recent->branchcode,
|
|
},
|
|
);
|
|
last if !$letter; # Letters.pm already warned, just exit
|
|
if( $nomail ) {
|
|
print $letter->{'content'}."\n";
|
|
} else {
|
|
C4::Letters::EnqueueLetter({
|
|
letter => $letter,
|
|
borrowernumber => $recent->borrowernumber,
|
|
from_address => $from_address,
|
|
message_transport_type => 'email',
|
|
});
|
|
}
|
|
}
|