Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 | 32 | */ |
6a488035 TO |
33 | abstract class CRM_SMS_Provider { |
34 | ||
35 | /** | |
36 | * We only need one instance of this object. So we use the singleton | |
37 | * pattern and cache the instance in this variable | |
38 | * | |
39 | * @var object | |
6a488035 TO |
40 | */ |
41 | static private $_singleton = array(); | |
7da04cde | 42 | const MAX_SMS_CHAR = 460; |
6a488035 TO |
43 | |
44 | /** | |
fe482240 | 45 | * Singleton function used to manage this object. |
6a488035 | 46 | * |
77b97be7 EM |
47 | * @param array $providerParams |
48 | * @param bool $force | |
49 | * | |
6a488035 | 50 | * @return object |
6a488035 | 51 | */ |
00be9182 | 52 | public static function &singleton($providerParams = array(), $force = FALSE) { |
353ffa53 TO |
53 | $mailingID = CRM_Utils_Array::value('mailing_id', $providerParams); |
54 | $providerID = CRM_Utils_Array::value('provider_id', $providerParams); | |
6a488035 TO |
55 | $providerName = CRM_Utils_Array::value('provider', $providerParams); |
56 | ||
57 | if (!$providerID && $mailingID) { | |
58 | $providerID = CRM_Core_DAO::getFieldValue('CRM_Mailing_DAO_Mailing', $mailingID, 'sms_provider_id', 'id'); | |
59 | $providerParams['provider_id'] = $providerID; | |
60 | } | |
61 | if ($providerID) { | |
62 | $providerName = CRM_SMS_BAO_Provider::getProviderInfo($providerID, 'name'); | |
63 | } | |
64 | ||
65 | if (!$providerName) { | |
66 | CRM_Core_Error::fatal('Provider not known or not provided.'); | |
67 | } | |
68 | ||
69 | $providerName = CRM_Utils_Type::escape($providerName, 'String'); | |
353ffa53 | 70 | $cacheKey = "{$providerName}_" . (int) $providerID . "_" . (int) $mailingID; |
6a488035 TO |
71 | |
72 | if (!isset(self::$_singleton[$cacheKey]) || $force) { | |
73 | $ext = CRM_Extension_System::singleton()->getMapper(); | |
74 | if ($ext->isExtensionKey($providerName)) { | |
36f5faa3 MW |
75 | $providerClass = $ext->keyToClass($providerName); |
76 | require_once "{$providerClass}.php"; | |
0db6c3e1 TO |
77 | } |
78 | else { | |
1a7f0799 MW |
79 | // If we are running unit tests we simulate an SMS provider with the name "CiviTestSMSProvider" |
80 | if ($providerName !== 'CiviTestSMSProvider') { | |
36f5faa3 MW |
81 | CRM_Core_Error::fatal("Could not locate extension for {$providerName}."); |
82 | } | |
1a7f0799 | 83 | $providerClass = 'CiviTestSMSProvider'; |
6a488035 TO |
84 | } |
85 | ||
36f5faa3 | 86 | self::$_singleton[$cacheKey] = $providerClass::singleton($providerParams, $force); |
6a488035 TO |
87 | } |
88 | return self::$_singleton[$cacheKey]; | |
89 | } | |
90 | ||
91 | /** | |
fe482240 | 92 | * Send an SMS Message via the API Server. |
54957108 | 93 | * |
94 | * @param array $recipients | |
95 | * @param string $header | |
96 | * @param string $message | |
97 | * @param int $dncID | |
6a488035 | 98 | */ |
2da40d21 | 99 | abstract public function send($recipients, $header, $message, $dncID = NULL); |
6a488035 TO |
100 | |
101 | /** | |
3bdf1f3a | 102 | * Return message text. |
103 | * | |
104 | * Child class could override this function to have better control over the message being sent. | |
105 | * | |
106 | * @param string $message | |
107 | * @param int $contactID | |
108 | * @param array $contactDetails | |
109 | * | |
110 | * @return string | |
6a488035 | 111 | */ |
00be9182 | 112 | public function getMessage($message, $contactID, $contactDetails) { |
6a488035 TO |
113 | $html = $message->getHTMLBody(); |
114 | $text = $message->getTXTBody(); | |
115 | ||
116 | return $html ? $html : $text; | |
117 | } | |
118 | ||
fd0e0077 | 119 | /** |
3bdf1f3a | 120 | * Get recipient details. |
121 | * | |
122 | * @param array $fields | |
123 | * @param array $additionalDetails | |
fd0e0077 EM |
124 | * |
125 | * @return mixed | |
126 | */ | |
00be9182 | 127 | public function getRecipientDetails($fields, $additionalDetails) { |
6a488035 TO |
128 | // we could do more altering here |
129 | $fields['To'] = $fields['phone']; | |
130 | return $fields; | |
131 | } | |
132 | ||
fd0e0077 | 133 | /** |
100fef9d | 134 | * @param int $apiMsgID |
fd0e0077 EM |
135 | * @param $message |
136 | * @param array $headers | |
100fef9d CW |
137 | * @param int $jobID |
138 | * @param int $userID | |
fd0e0077 | 139 | * |
6c552737 | 140 | * @return self|null|object |
fd0e0077 EM |
141 | * @throws CRM_Core_Exception |
142 | */ | |
00be9182 | 143 | public function createActivity($apiMsgID, $message, $headers = array(), $jobID = NULL, $userID = NULL) { |
6a488035 TO |
144 | if ($jobID) { |
145 | $sql = " | |
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'))); | |
149 | } | |
353ffa53 | 150 | elseif ($userID) { |
44fb209e | 151 | $sourceContactID = $userID; |
e8cb3963 | 152 | } |
6a488035 TO |
153 | else { |
154 | $session = CRM_Core_Session::singleton(); | |
155 | $sourceContactID = $session->get('userID'); | |
156 | } | |
157 | ||
158 | if (!$sourceContactID) { | |
1393e47e | 159 | $sourceContactID = CRM_Utils_Array::value('Contact', $headers); |
6a488035 TO |
160 | } |
161 | if (!$sourceContactID) { | |
44fb209e | 162 | return FALSE; |
6a488035 TO |
163 | } |
164 | ||
6a488035 TO |
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'], | |
36f5faa3 | 169 | 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS delivery'), |
6a488035 | 170 | 'activity_date_time' => date('YmdHis'), |
6a488035 TO |
171 | 'details' => $message, |
172 | 'result' => $apiMsgID, | |
173 | ); | |
174 | return CRM_Activity_BAO_Activity::create($activityParams); | |
175 | } | |
176 | ||
fd0e0077 | 177 | /** |
100fef9d | 178 | * @param string $name |
fd0e0077 EM |
179 | * @param $type |
180 | * @param bool $abort | |
181 | * @param null $default | |
182 | * @param string $location | |
183 | * | |
184 | * @return mixed | |
185 | */ | |
00be9182 | 186 | public function retrieve($name, $type, $abort = TRUE, $default = NULL, $location = 'REQUEST') { |
6a488035 TO |
187 | static $store = NULL; |
188 | $value = CRM_Utils_Request::retrieve($name, $type, $store, | |
189 | FALSE, $default, $location | |
190 | ); | |
191 | if ($abort && $value === NULL) { | |
36f5faa3 | 192 | Civi::log()->warning("Could not find an entry for $name in $location"); |
6a488035 TO |
193 | echo "Failure: Missing Parameter<p>"; |
194 | exit(); | |
195 | } | |
196 | return $value; | |
197 | } | |
198 | ||
fd0e0077 EM |
199 | /** |
200 | * @param $from | |
201 | * @param $body | |
202 | * @param null $to | |
100fef9d | 203 | * @param int $trackID |
fd0e0077 | 204 | * |
6c552737 | 205 | * @return self|null|object |
fd0e0077 EM |
206 | * @throws CRM_Core_Exception |
207 | */ | |
00be9182 | 208 | public function processInbound($from, $body, $to = NULL, $trackID = NULL) { |
caed3ddc SL |
209 | $message = new CRM_SMS_Message(); |
210 | $message->from = $from; | |
211 | $message->to = $to; | |
212 | $message->body = $body; | |
213 | $message->trackID = $trackID; | |
0613768a | 214 | // call hook_civicrm_inboundSMS |
caed3ddc | 215 | CRM_Utils_Hook::inboundSMS($message); |
0613768a | 216 | |
caed3ddc | 217 | if (!$message->fromContactID) { |
0613768a | 218 | // find sender by phone number if $fromContactID not set by hook |
caed3ddc | 219 | $formatFrom = '%' . $this->formatPhone($this->stripPhone($message->from), $like, "like"); |
d20cd5d4 | 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( |
caed3ddc | 221 | 1 => array($formatFrom, 'String'))); |
0613768a | 222 | } |
1393e47e | 223 | |
caed3ddc | 224 | if (!$message->fromContactID) { |
1393e47e | 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 | |
b2b0530a | 228 | $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
b4f964d9 CW |
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); | |
caed3ddc | 232 | $stripFrom = $this->stripPhone($message->from); |
b4f964d9 CW |
233 | $contactparams = array( |
234 | 'contact_type' => 'Individual', | |
44fb209e | 235 | 'email' => array( |
353ffa53 TO |
236 | 1 => array( |
237 | 'location_type_id' => $phoneloc, | |
238 | 'email' => $stripFrom . '@mobile.sms', | |
af9b09df | 239 | ), |
353ffa53 | 240 | ), |
44fb209e | 241 | 'phone' => array( |
353ffa53 TO |
242 | 1 => array( |
243 | 'phone_type_id' => $phonetype, | |
244 | 'location_type_id' => $phoneloc, | |
245 | 'phone' => $stripFrom, | |
af9b09df | 246 | ), |
353ffa53 | 247 | ), |
b4f964d9 | 248 | ); |
1393e47e | 249 | $fromContact = CRM_Contact_BAO_Contact::create($contactparams, FALSE, TRUE, FALSE); |
caed3ddc | 250 | $message->fromContactID = $fromContact->id; |
6a488035 TO |
251 | } |
252 | ||
d20cd5d4 | 253 | if (!$message->toContactID) { |
0613768a | 254 | // find recipient if $toContactID not set by hook |
caed3ddc | 255 | if ($message->to) { |
d20cd5d4 | 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( |
caed3ddc | 257 | 1 => array('%' . $message->to, 'String'))); |
0613768a EE |
258 | } |
259 | else { | |
d20cd5d4 | 260 | $message->toContactID = $message->fromContactID; |
0613768a | 261 | } |
6a488035 TO |
262 | } |
263 | ||
caed3ddc | 264 | if ($message->fromContactID) { |
6a488035 TO |
265 | // note: lets not pass status here, assuming status will be updated by callback |
266 | $activityParams = array( | |
caed3ddc SL |
267 | 'source_contact_id' => $message->toContactID, |
268 | 'target_contact_id' => $message->fromContactID, | |
36f5faa3 | 269 | 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound SMS'), |
6a488035 | 270 | 'activity_date_time' => date('YmdHis'), |
36f5faa3 | 271 | 'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'), |
caed3ddc SL |
272 | 'details' => $message->body, |
273 | 'phone_number' => $message->from, | |
6a488035 | 274 | ); |
caed3ddc | 275 | if ($message->trackID) { |
d20cd5d4 | 276 | $activityParams['result'] = CRM_Utils_Type::escape($message->trackID, 'String'); |
6a488035 TO |
277 | } |
278 | ||
279 | $result = CRM_Activity_BAO_Activity::create($activityParams); | |
36f5faa3 | 280 | Civi::log()->info("Inbound SMS recorded for cid={$message->fromContactID}."); |
6a488035 TO |
281 | return $result; |
282 | } | |
283 | } | |
284 | ||
fd0e0077 EM |
285 | /** |
286 | * @param $phone | |
287 | * | |
288 | * @return mixed|string | |
289 | */ | |
00be9182 | 290 | public function stripPhone($phone) { |
6a488035 TO |
291 | $newphone = preg_replace('/[^0-9x]/', '', $phone); |
292 | while (substr($newphone, 0, 1) == "1") { | |
293 | $newphone = substr($newphone, 1); | |
294 | } | |
295 | while (strpos($newphone, "xx") !== FALSE) { | |
296 | $newphone = str_replace("xx", "x", $newphone); | |
297 | } | |
298 | while (substr($newphone, -1) == "x") { | |
299 | $newphone = substr($newphone, 0, -1); | |
300 | } | |
301 | return $newphone; | |
302 | } | |
303 | ||
fd0e0077 EM |
304 | /** |
305 | * @param $phone | |
306 | * @param $kind | |
307 | * @param string $format | |
308 | * | |
309 | * @return mixed|string | |
310 | */ | |
00be9182 | 311 | public function formatPhone($phone, &$kind, $format = "dash") { |
6a488035 TO |
312 | $phoneA = explode("x", $phone); |
313 | switch (strlen($phoneA[0])) { | |
314 | case 0: | |
315 | $kind = "XOnly"; | |
316 | $area = ""; | |
317 | $exch = ""; | |
318 | $uniq = ""; | |
353ffa53 | 319 | $ext = $phoneA[1]; |
6a488035 TO |
320 | break; |
321 | ||
322 | case 7: | |
323 | $kind = $phoneA[1] ? "LocalX" : "Local"; | |
324 | $area = ""; | |
325 | $exch = substr($phone, 0, 3); | |
326 | $uniq = substr($phone, 3, 4); | |
353ffa53 | 327 | $ext = $phoneA[1]; |
6a488035 TO |
328 | break; |
329 | ||
330 | case 10: | |
331 | $kind = $phoneA[1] ? "LongX" : "Long"; | |
332 | $area = substr($phone, 0, 3); | |
333 | $exch = substr($phone, 3, 3); | |
334 | $uniq = substr($phone, 6, 4); | |
353ffa53 | 335 | $ext = $phoneA[1]; |
6a488035 TO |
336 | break; |
337 | ||
338 | default: | |
339 | $kind = "Unknown"; | |
340 | return $phone; | |
341 | } | |
342 | ||
343 | switch ($format) { | |
344 | case "like": | |
345 | $newphone = '%' . $area . '%' . $exch . '%' . $uniq . '%' . $ext . '%'; | |
346 | $newphone = str_replace('%%', '%', $newphone); | |
347 | $newphone = str_replace('%%', '%', $newphone); | |
348 | return $newphone; | |
349 | ||
350 | case "dash": | |
351 | $newphone = $area . "-" . $exch . "-" . $uniq . " x" . $ext; | |
352 | $newphone = trim(trim(trim($newphone, "x"), "-")); | |
353 | return $newphone; | |
354 | ||
355 | case "bare": | |
356 | $newphone = $area . $exch . $uniq . "x" . $ext; | |
357 | $newphone = trim(trim(trim($newphone, "x"), "-")); | |
358 | return $newphone; | |
359 | ||
360 | case "area": | |
361 | return $area; | |
362 | ||
363 | default: | |
364 | return $phone; | |
365 | } | |
366 | } | |
1e2f5f25 | 367 | |
fd0e0077 EM |
368 | /** |
369 | * @param $values | |
370 | * | |
371 | * @return string | |
372 | */ | |
00be9182 | 373 | public function urlEncode($values) { |
1e2f5f25 DS |
374 | $uri = ''; |
375 | foreach ($values as $key => $value) { | |
376 | $value = urlencode($value); | |
377 | $uri .= "&{$key}={$value}"; | |
378 | } | |
379 | if (!empty($uri)) { | |
380 | $uri = substr($uri, 1); | |
381 | } | |
382 | return $uri; | |
383 | } | |
96025800 | 384 | |
6a488035 | 385 | } |