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 Koha::Script;
  30 use C4::Context;
  31 use C4::Members::Messaging;
  32 use Getopt::Long;
  33 use Pod::Usage;
  34
  35
  36 sub usage {
  37     pod2usage( -verbose => 2 );
  38     exit;
  39 }
  40
  41
  42 sub force_borrower_messaging_defaults {
  43     my ($doit, $since, $not_expired, $no_overwrite, $category ) = @_;
  44
  45     print "Since: $since\n" if $since;
  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 1|
  54     if ( $since ) {
  55         $sql .= " AND bo.dateenrolled >= ?";
  56     }
  57     if ($not_expired) {
  58         $sql .= " AND bo.dateexpiry >= NOW()"
  59     }
  60     if( $no_overwrite ) {
  61         $sql .= " AND mp.borrowernumber IS NULL";
  62     }
  63     $sql .= " AND bo.categorycode = ?" if $category;
  64     my $sth = $dbh->prepare($sql);
  65     $sth->execute($since || (), $category || () );
  66     my $cnt = 0;
  67     while ( my ($borrowernumber, $categorycode) = $sth->fetchrow ) {
  68         print "$borrowernumber: $categorycode\n";
  69         next unless $doit;
  70         C4::Members::Messaging::SetMessagingPreferencesFromDefaults( {
  71             borrowernumber => $borrowernumber,
  72             categorycode   => $categorycode,
  73         } );
  74         $cnt++;
  75     }
  76     $dbh->commit();
  77     print "Total borrowers updated: $cnt\n" if $doit;
  78 }
  79
  80
  81 my ( $doit, $since, $help, $not_expired, $no_overwrite, $category );
  82 my $result = GetOptions(
  83     'doit'        => \$doit,
  84     'since:s'     => \$since,
  85     'not-expired' => \$not_expired,
  86     'no-overwrite'  => \$no_overwrite,
  87     'category:s'  => \$category,
  88     'help|h'      => \$help,
  89 );
  90
  91 usage() if $help;
  92
  93 force_borrower_messaging_defaults( $doit, $since, $not_expired, $no_overwrite, $category );
  94
  95 =head1 NAME
  96
  97 borrowers-force-messaging-defaults.pl
  98
  99 =head1 SYNOPSIS
 100
 101   borrowers-force-messaging-defaults.pl
 102   borrowers-force-messaging-defaults.pl --help
 103   borrowers-force-messaging-defaults.pl --doit
 104   borrowers-force-messaging-defaults.pl --doit --not-expired
 105   borrowers-force-messaging-defaults.pl --doit --category PT
 106
 107 =head1 DESCRIPTION
 108
 109 If the EnhancedMessagingPreferences syspref is enabled after borrowers have
 110 been created in the DB, those borrowers won't have messaging transport
 111 preferences default values as defined for their borrower category. So you would
 112 have to modify each borrower one by one if you would like to send them 'Hold
 113 Filled' notice for example.
 114
 115 This script creates/overwrites messaging preferences for all borrowers and sets
 116 them to default values defined for the category they belong to (unless you
 117 use the options -not-expired or -no-overwrite to update a subset).
 118
 119 =over 8
 120
 121 =item B<--help>
 122
 123 Prints this help
 124
 125 =item B<--doit>
 126
 127 Actually update the borrowers.
 128
 129 =item B<--not-expired>
 130
 131 Will only update active borrowers (borrowers who didn't pass their expiration date).
 132
 133 =item B<--no-overwrite>
 134
 135 Will only update patrons without messaging preferences and skip patrons that
 136 already set their preferences.
 137
 138 =item B<--category>
 139
 140 Will only update patrons in the category specified.
 141
 142 =back
 143
 144 =cut