3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 abstract class CRM_SMS_Provider
{
36 * We only need one instance of this object. So we use the singleton
37 * pattern and cache the instance in this variable
41 static private $_singleton = array();
42 const MAX_SMS_CHAR
= 460;
45 * Singleton function used to manage this object.
47 * @param array $providerParams
52 public static function &singleton($providerParams = array(), $force = FALSE) {
53 $mailingID = CRM_Utils_Array
::value('mailing_id', $providerParams);
54 $providerID = CRM_Utils_Array
::value('provider_id', $providerParams);
55 $providerName = CRM_Utils_Array
::value('provider', $providerParams);
57 if (!$providerID && $mailingID) {
58 $providerID = CRM_Core_DAO
::getFieldValue('CRM_Mailing_DAO_Mailing', $mailingID, 'sms_provider_id', 'id');
59 $providerParams['provider_id'] = $providerID;
62 $providerName = CRM_SMS_BAO_Provider
::getProviderInfo($providerID, 'name');
66 CRM_Core_Error
::fatal('Provider not known or not provided.');
69 $providerName = CRM_Utils_Type
::escape($providerName, 'String');
70 $cacheKey = "{$providerName}_" . (int) $providerID . "_" . (int) $mailingID;
72 if (!isset(self
::$_singleton[$cacheKey]) ||
$force) {
73 $ext = CRM_Extension_System
::singleton()->getMapper();
74 if ($ext->isExtensionKey($providerName)) {
75 $providerClass = $ext->keyToClass($providerName);
76 require_once "{$providerClass}.php";
79 // If we are running unit tests we simulate an SMS provider with the name "CiviTestSMSProvider"
80 if ($providerName !== 'CiviTestSMSProvider') {
81 CRM_Core_Error
::fatal("Could not locate extension for {$providerName}.");
83 $providerClass = 'CiviTestSMSProvider';
86 self
::$_singleton[$cacheKey] = $providerClass::singleton($providerParams, $force);
88 return self
::$_singleton[$cacheKey];
92 * Send an SMS Message via the API Server.
94 * @param array $recipients
95 * @param string $header
96 * @param string $message
99 abstract public function send($recipients, $header, $message, $dncID = NULL);
102 * Return message text.
104 * Child class could override this function to have better control over the message being sent.
106 * @param string $message
107 * @param int $contactID
108 * @param array $contactDetails
112 public function getMessage($message, $contactID, $contactDetails) {
113 $html = $message->getHTMLBody();
114 $text = $message->getTXTBody();
116 return $html ?
$html : $text;
120 * Get recipient details.
122 * @param array $fields
123 * @param array $additionalDetails
127 public function getRecipientDetails($fields, $additionalDetails) {
128 // we could do more altering here
129 $fields['To'] = $fields['phone'];
134 * @param int $apiMsgID
136 * @param array $headers
140 * @return self|null|object
141 * @throws CRM_Core_Exception
143 public function createActivity($apiMsgID, $message, $headers = array(), $jobID = NULL, $userID = NULL) {
146 SELECT scheduled_id FROM civicrm_mailing m
147 INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
148 $sourceContactID = CRM_Core_DAO
::singleValueQuery($sql, array(1 => array($jobID, 'Integer')));
151 $sourceContactID = $userID;
154 $session = CRM_Core_Session
::singleton();
155 $sourceContactID = $session->get('userID');
158 if (!$sourceContactID) {
159 $sourceContactID = CRM_Utils_Array
::value('Contact', $headers);
161 if (!$sourceContactID) {
165 // note: lets not pass status here, assuming status will be updated by callback
166 $activityParams = array(
167 'source_contact_id' => $sourceContactID,
168 'target_contact_id' => $headers['contact_id'],
169 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS delivery'),
170 'activity_date_time' => date('YmdHis'),
171 'details' => $message,
172 'result' => $apiMsgID,
174 return CRM_Activity_BAO_Activity
::create($activityParams);
178 * @param string $name
181 * @param null $default
182 * @param string $location
186 public function retrieve($name, $type, $abort = TRUE, $default = NULL, $location = 'REQUEST') {
187 static $store = NULL;
188 $value = CRM_Utils_Request
::retrieve($name, $type, $store,
189 FALSE, $default, $location
191 if ($abort && $value === NULL) {
192 Civi
::log()->warning("Could not find an entry for $name in $location");
193 echo "Failure: Missing Parameter<p>";
203 * @param int $trackID
205 * @return self|null|object
206 * @throws CRM_Core_Exception
208 public function processInbound($from, $body, $to = NULL, $trackID = NULL) {
209 $message = new CRM_SMS_Message();
210 $message->from
= $from;
212 $message->body
= $body;
213 $message->trackID
= $trackID;
214 // call hook_civicrm_inboundSMS
215 CRM_Utils_Hook
::inboundSMS($message);
217 if (!$message->fromContactID
) {
218 // find sender by phone number if $fromContactID not set by hook
219 $formatFrom = '%' . $this->formatPhone($this->stripPhone($message->from
), $like, "like");
220 $message->fromContactID
= CRM_Core_DAO
::singleValueQuery("SELECT contact_id FROM civicrm_phone JOIN civicrm_contact ON civicrm_contact.id = civicrm_phone.contact_id WHERE !civicrm_contact.is_deleted AND phone LIKE %1", array(
221 1 => array($formatFrom, 'String')));
224 if (!$message->fromContactID
) {
225 // unknown mobile sender -- create new contact
226 // use fake @mobile.sms email address for new contact since civi
227 // requires email or name for all contacts
228 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
229 $phoneTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
230 $phoneloc = array_search('Home', $locationTypes);
231 $phonetype = array_search('Mobile', $phoneTypes);
232 $stripFrom = $this->stripPhone($message->from
);
233 $contactparams = array(
234 'contact_type' => 'Individual',
237 'location_type_id' => $phoneloc,
238 'email' => $stripFrom . '@mobile.sms',
243 'phone_type_id' => $phonetype,
244 'location_type_id' => $phoneloc,
245 'phone' => $stripFrom,
249 $fromContact = CRM_Contact_BAO_Contact
::create($contactparams, FALSE, TRUE, FALSE);
250 $message->fromContactID
= $fromContact->id
;
253 if (!$message->toContactID
) {
254 // find recipient if $toContactID not set by hook
256 $message->toContactID
= CRM_Core_DAO
::singleValueQuery("SELECT contact_id FROM civicrm_phone JOIN civicrm_contact ON civicrm_contact.id = civicrm_phone.contact_id WHERE !civicrm_contact.is_deleted AND phone LIKE %1", array(
257 1 => array('%' . $message->to
, 'String')));
260 $message->toContactID
= $message->fromContactID
;
264 if ($message->fromContactID
) {
265 // note: lets not pass status here, assuming status will be updated by callback
266 $activityParams = array(
267 'source_contact_id' => $message->toContactID
,
268 'target_contact_id' => $message->fromContactID
,
269 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound SMS'),
270 'activity_date_time' => date('YmdHis'),
271 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
272 'details' => $message->body
,
273 'phone_number' => $message->from
,
275 if ($message->trackID
) {
276 $activityParams['result'] = CRM_Utils_Type
::escape($message->trackID
, 'String');
279 $result = CRM_Activity_BAO_Activity
::create($activityParams);
280 Civi
::log()->info("Inbound SMS recorded for cid={$message->fromContactID}.");
288 * @return mixed|string
290 public function stripPhone($phone) {
291 $newphone = preg_replace('/[^0-9x]/', '', $phone);
292 while (substr($newphone, 0, 1) == "1") {
293 $newphone = substr($newphone, 1);
295 while (strpos($newphone, "xx") !== FALSE) {
296 $newphone = str_replace("xx", "x", $newphone);
298 while (substr($newphone, -1) == "x") {
299 $newphone = substr($newphone, 0, -1);
307 * @param string $format
309 * @return mixed|string
311 public function formatPhone($phone, &$kind, $format = "dash") {
312 $phoneA = explode("x", $phone);
313 switch (strlen($phoneA[0])) {
323 $kind = $phoneA[1] ?
"LocalX" : "Local";
325 $exch = substr($phone, 0, 3);
326 $uniq = substr($phone, 3, 4);
331 $kind = $phoneA[1] ?
"LongX" : "Long";
332 $area = substr($phone, 0, 3);
333 $exch = substr($phone, 3, 3);
334 $uniq = substr($phone, 6, 4);
345 $newphone = '%' . $area . '%' . $exch . '%' . $uniq . '%' . $ext . '%';
346 $newphone = str_replace('%%', '%', $newphone);
347 $newphone = str_replace('%%', '%', $newphone);
351 $newphone = $area . "-" . $exch . "-" . $uniq . " x" . $ext;
352 $newphone = trim(trim(trim($newphone, "x"), "-"));
356 $newphone = $area . $exch . $uniq . "x" . $ext;
357 $newphone = trim(trim(trim($newphone, "x"), "-"));
373 public function urlEncode($values) {
375 foreach ($values as $key => $value) {
376 $value = urlencode($value);
377 $uri .= "&{$key}={$value}";
380 $uri = substr($uri, 1);