C4/SMS.pm

   1 package C4::SMS;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 2 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along with
  15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  16 # Suite 330, Boston, MA  02111-1307 USA
  17
  18 =head1 NAME
  19
  20 C4::SMS - send SMS messages
  21
  22 =head1 SYNOPSIS
  23
  24 my $success = C4::SMS->send_sms( message     => 'This is my text message',
  25                                  destination => '212-555-1212' );
  26
  27 =head1 DESCRIPTION
  28
  29
  30
  31 =cut
  32
  33 use strict;
  34 use warnings;
  35
  36 use C4::Context;
  37
  38 use vars qw( $VERSION );
  39
  40 BEGIN {
  41     $VERSION = 0.03;
  42 }
  43
  44 =head1 METHODS
  45
  46 =cut
  47
  48 # The previous implmentation used username and password.
  49 # our $user = C4::Context->config('smsuser');
  50 # our $pwd  = C4::Context->config('smspass');
  51
  52 =head2 send_sms
  53
  54 =over4
  55
  56 =back
  57
  58 =cut
  59
  60 sub send_sms {
  61     my $self = shift;
  62     my $params= shift;
  63
  64     foreach my $required_parameter ( qw( message destination ) ) {
  65         # Should I warn in some way?
  66         return unless defined $params->{ $required_parameter };
  67     }
  68
  69     eval { require SMS::Send; };
  70     if ( $@ ) {
  71         # we apparently don't have SMS::Send. Return a failure.
  72         return;
  73     }
  74
  75     # This allows the user to override the driver. See SMS::Send::Test
  76     my $driver = exists $params->{'driver'} ? $params->{'driver'} : $self->driver();
  77     return unless $driver;
  78
  79     # warn "using driver: $driver to send message to $params->{'destination'}";
  80
  81     # Create a sender
  82     my $sender = SMS::Send->new( $driver,
  83                                  _login    => C4::Context->preference('SMSSendUsername'),
  84                                  _password => C4::Context->preference('SMSSendPassword'),
  85                             );
  86
  87     # Send a message
  88     my $sent = $sender->send_sms( to   => $params->{'destination'},
  89                                   text => $params->{'message'},
  90                              );
  91     # warn 'failure' unless $sent;
  92     return $sent;
  93 }
  94
  95 =head2 driver
  96
  97 =over 4
  98
  99 =back
 100
 101 =cut
 102
 103 sub driver {
 104     my $self = shift;
 105
 106     # return 'US::SprintPCS';
 107     return C4::Context->preference('SMSSendDriver');
 108
 109 }
 110
 111 1;
 112
 113 __END__
 114