3 # Copyright Liblime 2009
4 # Copyright Catalyst IT 2012
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
32 C4::Message - object for messages in the message_queue table
36 How to add a new message to the queue:
40 my $borrower = { borrowernumber => 1 };
41 my $item = Koha::Items->find($itemnumber)->unblessed;
42 my $letter = C4::Letters::GetPreparedLetter (
43 module => 'circulation',
44 letter_code => 'CHECKOUT',
45 branchcode => $branch,
47 'biblio', $item->{biblionumber},
48 'biblioitems', $item->{biblionumber},
51 C4::Message->enqueue($letter, $borrower->{borrowernumber}, 'email');
53 How to update a borrower's last checkout message:
56 my $borrower = { borrowernumber => 1 };
57 my $message = C4::Message->find_last_message($borrower, 'CHECKOUT', 'email');
58 $message->append("you also checked out some other book....");
63 This module presents an OO interface to the message_queue. Previously,
64 you could only add messages to the message_queue via
65 C<C4::Letters::EnqueueMessage()>. With this module, you can also get
66 previously inserted messages, manipulate them, and save them back to the
77 =head3 C4::Message->new(\%attributes)
79 This method creates an in-memory version of a message object.
83 # C4::Message->new(\%attributes) -- constructor
85 my ($class, $opts) = @_;
87 bless {%$opts} => $class;
91 =head3 C4::Message->find($id)
93 This method searches the message_queue table for a row with the given
94 C<message_id> and it'll return a C4::Message object if it finds one.
98 # C4::Message->find($id) -- find a message by its message_id
100 my ($class, $id) = @_;
101 my $dbh = C4::Context->dbh;
102 my $msgs = $dbh->selectall_arrayref(
103 qq{SELECT * FROM message_queue WHERE message_id = ?},
108 return $class->new($msgs->[0]);
114 =head3 C4::Message->find_last_message($borrower, $letter_code, $transport)
116 This method is used to get the borrower's most recent, pending, check-in or
117 checkout message. (This makes it possible to add more information to the
118 message before it gets sent out.)
122 # C4::Message->find_last_message($borrower, $letter_code, $transport)
123 # -- get the borrower's most recent pending checkin or checkout notification
124 sub find_last_message {
125 my ($class, $borrower, $letter_code, $transport) = @_;
126 # $type is the message_transport_type
127 $transport ||= 'email';
128 my $dbh = C4::Context->dbh;
129 my $msgs = $dbh->selectall_arrayref(
133 WHERE status = 'pending'
134 AND borrowernumber = ?
136 AND message_transport_type = ?
139 $borrower->{borrowernumber},
144 return $class->new($msgs->[0]);
151 =head3 C4::Message->enqueue($letter, $borrower, $transport)
153 This is a front-end for C<C4::Letters::EnqueueLetter()> that adds metadata to
158 # C4::Message->enqueue($letter, $borrower, $transport)
160 my ($class, $letter, $borrower, $transport) = @_;
161 my $metadata = _metadata($letter);
162 my $to_address = _to_address($borrower, $transport);
164 # Same as render_metadata
165 my $format ||= sub { $_[0] || "" };
166 my $body = join('', map { $format->($_) } @{$metadata->{body}});
167 $letter->{content} = $metadata->{header} . $body . $metadata->{footer};
169 $letter->{metadata} = Encode::decode_utf8(Dump($metadata));
170 C4::Letters::EnqueueLetter({
172 borrowernumber => $borrower->{borrowernumber},
173 message_transport_type => $transport,
174 to_address => $to_address,
178 # based on message $transport, pick an appropriate address to send to
180 my ($borrower, $transport) = @_;
182 if ($transport eq 'email') {
183 $address = $borrower->{email}
184 || $borrower->{emailpro}
185 || $borrower->{B_email};
186 } elsif ($transport eq 'sms') {
187 $address = $borrower->{smsalertnumber}
188 || $borrower->{phone}
189 || $borrower->{phonepro}
190 || $borrower->{B_phone};
192 warn "'$transport' is an unknown message transport.";
194 if (not defined $address) {
195 warn "An appropriate $transport address "
196 . "for borrower $borrower->{userid} "
197 . "could not be found.";
202 # _metadata($letter) -- return the letter split into head/body/footer
205 if ($letter->{content} =~ /----/) {
206 my ($header, $body, $footer) = split(/----\r?\n?/, $letter->{content});
215 body => [$letter->{content}],
221 =head2 Instance Methods
223 =head3 $message->update()
225 This saves the $message object back to the database. It needs to have
226 already been created via C<enqueue> for this to work.
230 # $object->update -- save object to database
233 my $dbh = C4::Context->dbh;
243 message_transport_type = ?,
252 $self->borrowernumber,
255 $self->{metadata}, # we want the raw YAML here
257 $self->message_transport_type,
267 =head3 $message->metadata(\%new_metadata)
269 This method automatically serializes and deserializes the metadata
270 attribute. (It is stored in YAML format.)
274 # $object->metadata -- this is a YAML serialized column that contains a
275 # structured representation of $object->content
277 my ($self, $data) = @_;
279 $data->{header} ||= '';
280 $data->{body} ||= [];
281 $data->{footer} ||= '';
282 $self->{metadata} = Encode::decode_utf8(Dump($data));
283 $self->content($self->render_metadata);
286 return YAML::XS::Load(Encode::encode_utf8($self->{metadata}));
290 # turn $object->metadata into a string suitable for $object->content
291 sub render_metadata {
292 my ($self, $format) = @_;
293 $format ||= sub { $_[0] || "" };
294 my $metadata = $self->metadata;
295 my $body = $metadata->{body};
296 my $text = join('', map { $format->($_) } @$body);
297 return $metadata->{header} . $text . $metadata->{footer};
300 =head3 $message->append(\%letter)
302 If passed a hashref, this method will assume that the hashref is in the form
303 that C<C4::Letters::getletter()> returns. It will append the body of the
304 letter to the message.
306 =head3 $message->append($string)
308 If passed a string, it'll append the string to the message.
312 # $object->append($letter_or_item) -- add a new item to a message's content
314 my ($self, $letter_or_item, $format) = @_;
315 my ( $item, $header, $footer );
316 if (ref($letter_or_item)) {
317 my $letter = $letter_or_item;
318 my $metadata = _metadata($letter);
319 $header = $metadata->{header};
320 $footer = $metadata->{footer};
321 $item = $metadata->{body}->[0];
323 $item = $letter_or_item;
325 if (not $self->metadata) {
326 carp "Can't append to messages that don't have metadata.";
329 my $metadata = $self->metadata;
330 push @{$metadata->{body}}, $item;
331 $metadata->{header} = $header;
332 $metadata->{footer} = $footer;
333 $self->metadata($metadata);
334 my $new_content = $self->render_metadata($format);
335 return $self->content($new_content);
338 =head2 Attributes Accessors
340 =head3 $message->message_id
344 =head3 $message->borrowernumber
348 =head3 $message->subject
352 =head3 $message->content
356 =head3 $message->metadata
360 =head3 $message->letter_code
364 =head3 $message->message_transport_type
368 =head3 $message->status
372 =head3 $message->time_queued
376 =head3 $message->to_address
380 =head3 $message->from_address
384 =head3 $message->content_type
388 # $object->$method -- treat keys as methods
390 my ($self, @args) = @_;
391 my $attr = $AUTOLOAD;
393 if (ref($self->{$attr}) eq 'CODE') {
394 $self->{$attr}->($self, @args);
397 $self->{$attr} = $args[0];
410 L<C4::Circulation>, L<C4::Letters>, L<C4::Members::Messaging>
414 John Beppu <john.beppu@liblime.com>