1 package C4::Members::Messaging;
3 # Copyright (C) 2008 LibLime
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 use vars qw($VERSION);
27 # set the version for version checking
33 C4::Members::Messaging - manage patron messaging preferences
37 use C4::Members::Messaging
41 This module lets you modify a patron's messaging preferences.
45 =head2 GetMessagingPreferences
47 my $preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrower->{'borrowernumber'},
48 message_name => 'DUE' } );
50 my $preferences = C4::Members::Messaging::GetMessagingPreferences( { categorycode => 'LIBRARY',
51 message_name => 'DUE' } );
53 returns: a hashref of messaging preferences for a borrower or patron category for a particlar message_name
55 Requires either a borrowernumber or a categorycode key, but not both.
59 sub GetMessagingPreferences {
62 return unless exists $params->{message_name};
63 return unless exists $params->{borrowernumber} xor exists $params->{categorycode}; # yes, xor
65 my $sql = <<'END_SQL';
66 SELECT borrower_message_preferences.*,
67 borrower_message_transport_preferences.message_transport_type,
70 FROM borrower_message_preferences
71 LEFT JOIN borrower_message_transport_preferences
72 ON borrower_message_transport_preferences.borrower_message_preference_id = borrower_message_preferences.borrower_message_preference_id
73 LEFT JOIN message_attributes
74 ON message_attributes.message_attribute_id = borrower_message_preferences.message_attribute_id
75 LEFT JOIN message_transports
76 ON message_transports.message_attribute_id = message_attributes.message_attribute_id
77 AND message_transports.message_transport_type = borrower_message_transport_preferences.message_transport_type
78 WHERE message_attributes.message_name = ?
81 my @bind_params = ( $params->{'message_name'} );
82 if ( exists $params->{'borrowernumber'} ) {
83 $sql .= " AND borrower_message_preferences.borrowernumber = ? ";
84 push @bind_params, $params->{borrowernumber};
86 $sql .= " AND borrower_message_preferences.categorycode = ? ";
87 push @bind_params, $params->{categorycode};
90 my $sth = C4::Context->dbh->prepare($sql);
91 $sth->execute(@bind_params);
93 my %transports; # helps build a list of unique message_transport_types
94 ROW: while ( my $row = $sth->fetchrow_hashref() ) {
95 next ROW unless $row->{'message_attribute_id'};
96 # warn( Data::Dumper->Dump( [ $row ], [ 'row' ] ) );
97 $return->{'days_in_advance'} = $row->{'days_in_advance'} if defined $row->{'days_in_advance'};
98 $return->{'wants_digest'} = $row->{'wants_digest'} if defined $row->{'wants_digest'};
99 $return->{'letter_code'} = $row->{'letter_code'};
100 $transports{$row->{'message_transport_type'}} = 1;
102 @{$return->{'transports'}} = keys %transports;
106 =head2 SetMessagingPreference
108 This method defines how a user (or a default for a patron category) wants to get a certain
109 message delivered. The list of valid message types can be delivered can be found in the
110 C<message_attributes> table, and the list of valid message transports can be
111 found in the C<message_transport_types> table.
113 C4::Members::Messaging::SetMessagingPreference( { borrowernumber => $borrower->{'borrowernumber'}
114 message_attribute_id => $message_attribute_id,
115 message_transport_types => [ qw( email sms ) ],
117 wants_digest => 1 } )
119 returns nothing useful.
123 sub SetMessagingPreference {
126 unless (exists $params->{borrowernumber} xor exists $params->{categorycode}) { # yes, xor
127 warn "SetMessagingPreference called without exactly one of borrowernumber or categorycode";
130 foreach my $required ( qw( message_attribute_id message_transport_types ) ) {
131 if ( ! exists $params->{ $required } ) {
132 warn "SetMessagingPreference called without required parameter: $required";
136 $params->{'days_in_advance'} = undef unless exists ( $params->{'days_in_advance'} );
137 $params->{'wants_digest'} = 0 unless exists ( $params->{'wants_digest'} );
139 my $dbh = C4::Context->dbh();
141 my $delete_sql = <<'END_SQL';
142 DELETE FROM borrower_message_preferences
143 WHERE message_attribute_id = ?
145 my @bind_params = ( $params->{'message_attribute_id'} );
146 if ( exists $params->{'borrowernumber'} ) {
147 $delete_sql .= " AND borrowernumber = ? ";
148 push @bind_params, $params->{borrowernumber};
150 $delete_sql .= " AND categorycode = ? ";
151 push @bind_params, $params->{categorycode};
153 my $sth = $dbh->prepare( $delete_sql );
154 my $deleted = $sth->execute( @bind_params );
156 if ( $params->{'message_transport_types'} ) {
157 my $insert_bmp = <<'END_SQL';
158 INSERT INTO borrower_message_preferences
159 (borrower_message_preference_id, borrowernumber, categorycode, message_attribute_id, days_in_advance, wants_digest)
161 (NULL, ?, ?, ?, ?, ?)
164 $sth = C4::Context->dbh()->prepare($insert_bmp);
165 # set up so that we can easily construct the insert SQL
166 $params->{'borrowernumber'} = undef unless exists ( $params->{'borrowernumber'} );
167 $params->{'categorycode'} = undef unless exists ( $params->{'categorycode'} );
168 my $success = $sth->execute( $params->{'borrowernumber'},
169 $params->{'categorycode'},
170 $params->{'message_attribute_id'},
171 $params->{'days_in_advance'},
172 $params->{'wants_digest'} );
173 # my $borrower_message_preference_id = $dbh->last_insert_id();
174 my $borrower_message_preference_id = $dbh->{'mysql_insertid'};
176 my $insert_bmtp = <<'END_SQL';
177 INSERT INTO borrower_message_transport_preferences
178 (borrower_message_preference_id, message_transport_type)
182 $sth = C4::Context->dbh()->prepare($insert_bmtp);
183 foreach my $transport ( @{$params->{'message_transport_types'}}) {
184 my $success = $sth->execute( $borrower_message_preference_id, $transport );
190 =head2 GetMessagingOptions
192 my $messaging_options = C4::Members::Messaging::GetMessagingOptions()
194 returns a hashref of messaging options available.
198 sub GetMessagingOptions {
200 my $sql = <<'END_SQL';
201 select message_attributes.message_attribute_id, takes_days, message_name, message_transport_type, is_digest
202 FROM message_attributes
203 LEFT JOIN message_transports
204 ON message_attributes.message_attribute_id = message_transports.message_attribute_id
207 my $sth = C4::Context->dbh->prepare($sql);
210 while ( my $row = $sth->fetchrow_hashref() ) {
211 $choices->{ $row->{'message_name'} }->{'message_attribute_id'} = $row->{'message_attribute_id'};
212 $choices->{ $row->{'message_name'} }->{'message_name'} = $row->{'message_name'};
213 $choices->{ $row->{'message_name'} }->{'takes_days'} = $row->{'takes_days'};
214 $choices->{ $row->{'message_name'} }->{'has_digest'} = 1 if $row->{'is_digest'};
215 $choices->{ $row->{'message_name'} }->{'transport-' . $row->{'message_transport_type'}} = ' ';
218 my @return = values %$choices;
219 # warn( Data::Dumper->Dump( [ \@return ], [ 'return' ] ) );
223 =head2 SetMessagingPreferencesFromDefaults
225 C4::Members::Messaging::SetMessagingPreferenceFromDefaults( { borrowernumber => $borrower->{'borrowernumber'}
226 categorycode => 'CPL' } );
228 Given a borrowernumber and a patron category code (from the C<borrowernumber> and C<categorycode> keys
229 in the parameter hashref), replace all of the patron's current messaging preferences with
230 whatever defaults are defined for the patron category.
234 sub SetMessagingPreferencesFromDefaults {
237 foreach my $required ( qw( borrowernumber categorycode ) ) {
238 unless ( exists $params->{ $required } ) {
239 die "SetMessagingPreferencesFromDefaults called without required parameter: $required";
243 my $messaging_options = GetMessagingOptions();
244 OPTION: foreach my $option ( @$messaging_options ) {
245 my $default_pref = GetMessagingPreferences( { categorycode => $params->{categorycode},
246 message_name => $option->{'message_name'} } );
247 # FIXME - except for setting the borrowernumber, it really ought to be possible
248 # to have the output of GetMessagingPreferences be able to be the input
249 # to SetMessagingPreference
250 $default_pref->{message_attribute_id} = $option->{'message_attribute_id'};
251 $default_pref->{message_transport_types} = $default_pref->{transports};
252 $default_pref->{borrowernumber} = $params->{borrowernumber};
253 SetMessagingPreference( $default_pref );
261 The actual messages which will be sent via a cron job running
262 F<misc/cronjobs/process_message_queue.pl>.
264 =head2 message_attributes
266 What kinds of messages can be sent?
268 =head2 message_transport_types
270 What transports can messages be sent vith? (email, sms, etc.)
272 =head2 message_transports
274 How are message_attributes and message_transport_types correlated?
276 =head2 borrower_message_preferences
278 What messages do the borrowers want to receive?
280 =head2 borrower_message_transport_preferences
282 What transport should a message be sent with?
286 =head2 Adding a New Kind of Message to the System
292 Add a new template to the `letter` table.
296 Insert a row into the `message_attributes` table.
300 Insert rows into `message_transports` for each message_transport_type.
310 Koha Development Team <http://koha-community.org/>
312 Andrew Moore <andrew.moore@liblime.com>