misc/maintenance/borrowers-force-messaging-defaults.pl

   1 #!/usr/bin/perl
   2 #
   3 # Copyright (C) 2011 Tamil s.a.r.l.
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22 BEGIN {
  23     # find Koha's Perl modules
  24     # test carefully before changing this
  25     use FindBin;
  26     eval { require "$FindBin::Bin/../kohalib.pl" };
  27 }
  28
  29 use C4::Context;
  30 use C4::Members::Messaging;
  31 use Getopt::Long;
  32 use Pod::Usage;
  33
  34
  35 sub usage {
  36     pod2usage( -verbose => 2 );
  37     exit;
  38 }
  39
  40
  41 sub force_borrower_messaging_defaults {
  42     my ($doit, $since, $not_expired, $no_overwrite) = @_;
  43
  44     $since = '0000-00-00' if (!$since);
  45     print "Since: $since\n";
  46
  47     my $dbh = C4::Context->dbh;
  48     $dbh->{AutoCommit} = 0;
  49
  50     my $sql =
  51 q|SELECT DISTINCT bo.borrowernumber, bo.categorycode FROM borrowers bo
  52 LEFT JOIN borrower_message_preferences mp USING (borrowernumber)
  53 WHERE bo.dateenrolled >= ?|;
  54     if ($not_expired) {
  55         $sql .= " AND bo.dateexpiry >= NOW()"
  56     }
  57     if( $no_overwrite ) {
  58         $sql .= " AND mp.borrowernumber IS NULL";
  59     }
  60     my $sth = $dbh->prepare($sql);
  61     $sth->execute($since);
  62     while ( my ($borrowernumber, $categorycode) = $sth->fetchrow ) {
  63         print "$borrowernumber: $categorycode\n";
  64         next unless $doit;
  65         C4::Members::Messaging::SetMessagingPreferencesFromDefaults( {
  66             borrowernumber => $borrowernumber,
  67             categorycode   => $categorycode,
  68         } );
  69     }
  70     $dbh->commit();
  71 }
  72
  73
  74 my ( $doit, $since, $help, $not_expired, $no_overwrite );
  75 my $result = GetOptions(
  76     'doit'        => \$doit,
  77     'since:s'     => \$since,
  78     'not-expired' => \$not_expired,
  79     'no-overwrite'  => \$no_overwrite,
  80     'help|h'      => \$help,
  81 );
  82
  83 usage() if $help;
  84
  85 force_borrower_messaging_defaults( $doit, $since, $not_expired, $no_overwrite );
  86
  87 =head1 NAME
  88
  89 borrowers-force-messaging-defaults.pl
  90
  91 =head1 SYNOPSIS
  92
  93   borrowers-force-messaging-defaults.pl
  94   borrowers-force-messaging-defaults.pl --help
  95   borrowers-force-messaging-defaults.pl --doit
  96   borrowers-force-messaging-defaults.pl --doit --not-expired
  97
  98 =head1 DESCRIPTION
  99
 100 If the EnhancedMessagingPreferences syspref is enabled after borrowers have
 101 been created in the DB, those borrowers won't have messaging transport
 102 preferences default values as defined for their borrower category. So you would
 103 have to modify each borrower one by one if you would like to send them 'Hold
 104 Filled' notice for example.
 105
 106 This script creates/overwrites messaging preferences for all borrowers and sets
 107 them to default values defined for the category they belong to (unless you
 108 use the options -not-expired or -no-overwrite to update a subset).
 109
 110 =over 8
 111
 112 =item B<--help>
 113
 114 Prints this help
 115
 116 =item B<--doit>
 117
 118 Actually update the borrowers.
 119
 120 =item B<--not-expired>
 121
 122 Will only update active borrowers (borrowers who didn't pass their expiration date).
 123
 124 =item B<--no-overwrite>
 125
 126 Will only update patrons without messaging preferences and skip patrons that
 127 already set their preferences.
 128
 129 =back
 130
 131 =cut