Resolving VUFIND-635 (Enable SMS record via Clickatell); some additional work...

Resolving VUFIND-635 (Enable SMS record via Clickatell); some additional work may still be needed to get Unicode characters to transfer correctly.

config/vufind/sms.ini

 [General]
+; Set smsType to Clickatell and fill in [Clickatell] below to use the Clickatell
+; online SMS API (you will need a Clickatell account).
 ; Set smsType to Mailer to use VuFind's internal mailer for SMS (default).
 ;smsType = Mailer
 
@@ -13,6 +15,7 @@ filter = "-.() "
 ; The format is: unique_identifier = carrier.domain.name:Display Name
 ;
 ; For additional carriers, you may find it useful to refer to http://www.txt2day.com.
+; This section is ignored if smsType is set to Clickatell.
 [Carriers]
 ; Carriers in the US
 virgin = vmobl.com:"Virgin Mobile"
@@ -32,3 +35,12 @@ Cricket = mms.mycricket.com:"Cricket"
 ;vmobile.ca = vmobile.ca:"Virgin Mobile (Canada)"
 ;mobiletxt.ca = mobiletxt.ca:"PC Mobile"
 ;koodomobile.com = msg.koodomobile.com:"Koodo"
+
+; Uncomment this section and fill in the details if you choose Clickatell as smsType
+;[Clickatell]
+; You can uncomment this line to use a custom Clickatell API URL; by default, VuFind
+; will attempt to access the API over SSL (HTTPS), but HTTP is also allowed.
+;url = "http://api.clickatell.com/http/sendmsg?"
+;user = XXXX
+;password = XXXX
+;api_id = XXXX

module/VuFind/src/VuFind/SMS/Clickatell.php

+<?php
+/**
+ * Class for text messaging via Clickatell's HTTP API
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2009.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * @category VuFind2
+ * @package  SMS
+ * @author   Ronan McHugh <vufind-tech@lists.sourceforge.net>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     http://vufind.org/wiki/system_classes Wiki
+ */
+namespace VuFind\SMS;
+use VuFind\Exception\Mail as MailException;
+
+/**
+ * Class for text messaging via Clickatell's HTTP API
+ *
+ * @category VuFind2
+ * @package  SMS
+ * @author   Ronan McHugh <vufind-tech@lists.sourceforge.net>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     http://vufind.org/wiki/system_classes Wiki
+ */
+class Clickatell extends AbstractBase
+{
+    /**
+     * Send a text message to the specified provider.
+     *
+     * @param string $provider The provider ID to send to
+     * @param string $to       The phone number at the provider
+     * @param string $from     The email address to use as sender
+     * @param string $message  The message to send
+     *
+     * @throws \VuFind\Exception\Mail
+     * @return void
+     */
+    public function text($provider, $to, $from, $message)
+    {
+        // Get API settings from config
+        $user = isset($this->smsConfig->Clickatell->user)
+            ? $this->smsConfig->Clickatell->user : null;
+        $password = isset($this->smsConfig->Clickatell->password)
+            ? $this->smsConfig->Clickatell->password : null;
+        $api_id = isset($this->smsConfig->Clickatell->api_id)
+            ? $this->smsConfig->Clickatell->api_id : null;
+        $url = isset($this->smsConfig->Clickatell->url)
+            ? trim($this->smsConfig->Clickatell->url, '?')
+            : "https://api.clickatell.com/http/sendmsg";
+
+        // Clickatell expects UCS-2 encoding:
+        if (!function_exists('iconv')) {
+            throw new MailException('Clickatell requires iconv PHP extension.');
+        }
+        $message = iconv('UTF-8', 'ISO-8859-1//TRANSLIT', $message);
+
+        // We need to trim to 160 bytes (note that we need to use substr and not
+        // mb_substr, because the limit is BYTES not CHARACTERS; this may result
+        // in broken multi-byte characters but it seems unavoidable):
+        $message = substr($message, 0, 160);
+
+        // Add parameters to URL:
+        $url .= "?api_id=" . urlencode($api_id);
+        $url .= "&user=" . urlencode($user);
+        $url .= "&password=" . urlencode($password);
+        $url .= "&to=" . urlencode($this->filterPhoneNumber($to));
+        $url .= "&text=" . urlencode($message);
+
+        try {
+            $client = new \VuFind\Http\Client();
+            $result = $client->setMethod('GET')->setUri($url)->send();
+        } catch (\Exception $e) {
+            throw new MailException($e->getMessage());
+        }
+        $response = $result->isSuccess() ? trim($result->getBody()) : '';
+        if (empty($response)) {
+            throw new MailException('Problem sending text.');
+        }
+        if ('ID:' !== substr($response, 0, 3)) {
+            throw new MailException($response);
+        }
+        return true;
+    }
+
+    /**
+     * Get a list of carriers supported by the module.  Returned as an array of
+     * associative arrays indexed by carrier ID and containing "name" and "domain"
+     * keys.
+     *
+     * @access public
+     */
+    public function getCarriers()
+    {
+        return array(
+            'Clickatell' => array('name' => 'Clickatell', 'domain' => null)
+        );
+    }
+}

module/VuFind/src/VuFind/SMS/Factory.php

@@ -59,6 +59,8 @@ class Factory implements \Zend\ServiceManager\FactoryInterface
 
         // Initialize object based on requested type:
         switch (strtolower($type)) {
+        case 'clickatell':
+            return new Clickatell($smsConfig);
         case 'mailer':
             $options = array('mailer' => $sm->get('VuFind\Mailer'));
             if (isset($mainConfig->Site->email)) {