Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This file is used to build the form configuring mass sms details | |
38 | */ | |
39 | class CRM_SMS_Form_Upload extends CRM_Core_Form { | |
40 | public $_mailingID; | |
41 | ||
00be9182 | 42 | public function preProcess() { |
6a488035 TO |
43 | $this->_mailingID = $this->get('mailing_id'); |
44 | if (CRM_Core_Permission::check('administer CiviCRM')) { | |
45 | $this->assign('isAdmin', 1); | |
46 | } | |
47 | } | |
48 | ||
49 | /** | |
c490a46a | 50 | * Set default values for the form. |
6a488035 TO |
51 | * the default values are retrieved from the database |
52 | * | |
6a488035 | 53 | * |
355ba699 | 54 | * @return void |
6a488035 | 55 | */ |
00be9182 | 56 | public function setDefaultValues() { |
6a488035 TO |
57 | $mailingID = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE, NULL); |
58 | ||
59 | //need to differentiate new/reuse mailing, CRM-2873 | |
60 | $reuseMailing = FALSE; | |
61 | if ($mailingID) { | |
62 | $reuseMailing = TRUE; | |
63 | } | |
64 | else { | |
65 | $mailingID = $this->_mailingID; | |
66 | } | |
67 | ||
68 | $count = $this->get('count'); | |
69 | $this->assign('count', $count); | |
70 | ||
71 | $this->set('skipTextFile', FALSE); | |
72 | ||
73 | $defaults = array(); | |
74 | ||
75 | if ($mailingID) { | |
76 | $dao = new CRM_Mailing_DAO_Mailing(); | |
77 | $dao->id = $mailingID; | |
78 | $dao->find(TRUE); | |
79 | $dao->storeValues($dao, $defaults); | |
80 | ||
81 | //we don't want to retrieve template details once it is | |
82 | //set in session | |
83 | $templateId = $this->get('template'); | |
84 | $this->assign('templateSelected', $templateId ? $templateId : 0); | |
85 | if (isset($defaults['msg_template_id']) && !$templateId) { | |
1e035d58 | 86 | $defaults['SMStemplate'] = $defaults['msg_template_id']; |
c6327d7d | 87 | $messageTemplate = new CRM_Core_DAO_MessageTemplate(); |
6a488035 TO |
88 | $messageTemplate->id = $defaults['msg_template_id']; |
89 | $messageTemplate->selectAdd(); | |
90 | $messageTemplate->selectAdd('msg_text'); | |
91 | $messageTemplate->find(TRUE); | |
92 | ||
1e035d58 | 93 | $defaults['sms_text_message'] = $messageTemplate->msg_text; |
6a488035 TO |
94 | } |
95 | ||
96 | if (isset($defaults['body_text'])) { | |
1e035d58 | 97 | $defaults['sms_text_message'] = $defaults['body_text']; |
6a488035 TO |
98 | $this->set('textFile', $defaults['body_text']); |
99 | $this->set('skipTextFile', TRUE); | |
100 | } | |
101 | } | |
102 | ||
103 | //fix for CRM-2873 | |
104 | if (!$reuseMailing) { | |
105 | $textFilePath = $this->get('textFilePath'); | |
106 | if ($textFilePath && | |
107 | file_exists($textFilePath) | |
108 | ) { | |
1e035d58 | 109 | $defaults['sms_text_message'] = file_get_contents($textFilePath); |
110 | if (strlen($defaults['sms_text_message']) > 0) { | |
6a488035 TO |
111 | $this->set('skipTextFile', TRUE); |
112 | } | |
113 | } | |
114 | } | |
115 | ||
116 | $defaults['upload_type'] = 1; | |
117 | ||
118 | return $defaults; | |
119 | } | |
120 | ||
121 | /** | |
c490a46a | 122 | * Build the form object |
6a488035 | 123 | * |
355ba699 | 124 | * @return void |
6a488035 TO |
125 | */ |
126 | public function buildQuickForm() { | |
127 | $session = CRM_Core_Session::singleton(); | |
128 | $config = CRM_Core_Config::singleton(); | |
129 | $options = array(); | |
130 | $tempVar = FALSE; | |
131 | ||
132 | $this->assign('max_sms_length', CRM_SMS_Provider::MAX_SMS_CHAR); | |
133 | ||
134 | // this seems so hacky, not sure what we are doing here and why. Need to investigate and fix | |
135 | $session->getVars($options, | |
136 | "CRM_SMS_Controller_Send_{$this->controller->_key}" | |
137 | ); | |
138 | ||
139 | $providers = CRM_SMS_BAO_Provider::getProviders(array('id', 'title')); | |
140 | ||
141 | if (empty($providers)) { | |
142 | //redirect user to configure sms provider. | |
143 | $url = CRM_Utils_System::url('civicrm/admin/sms/provider', 'action=add&reset=1'); | |
144 | $status = ts("There is no SMS Provider Configured. You can add here <a href='%1'>Add SMS Provider</a>", array(1 => $url)); | |
145 | $session->setStatus($status); | |
146 | } | |
147 | else { | |
148 | $providerSelect[''] = '- select -'; | |
149 | foreach ($providers as $provider) { | |
150 | $providerSelect[$provider['id']] = $provider['title']; | |
151 | } | |
152 | } | |
153 | ||
154 | $this->add('select', 'sms_provider_id', | |
155 | ts('SMS Provider'), $providerSelect, TRUE | |
156 | ); | |
157 | ||
158 | $attributes = array('onclick' => "showHideUpload();"); | |
159 | $options = array(ts('Upload Content'), ts('Compose On-screen')); | |
160 | ||
161 | $this->addRadio('upload_type', ts('I want to'), $options, $attributes, " "); | |
162 | ||
163 | CRM_Mailing_BAO_Mailing::commonCompose($this); | |
164 | ||
165 | $this->addElement('file', 'textFile', ts('Upload TEXT Message'), 'size=30 maxlength=60'); | |
166 | $this->setMaxFileSize(1024 * 1024); | |
167 | $this->addRule('textFile', ts('File size should be less than 1 MByte'), 'maxfilesize', 1024 * 1024); | |
168 | $this->addRule('textFile', ts('File must be in UTF-8 encoding'), 'utf8File'); | |
169 | ||
170 | $this->addFormRule(array('CRM_SMS_Form_Upload', 'formRule'), $this); | |
171 | ||
172 | $buttons = array( | |
173 | array('type' => 'back', | |
174 | 'name' => ts('<< Previous'), | |
175 | ), | |
176 | array( | |
177 | 'type' => 'upload', | |
178 | 'name' => ts('Next >>'), | |
179 | 'spacing' => ' ', | |
180 | 'isDefault' => TRUE, | |
181 | ), | |
182 | array( | |
183 | 'type' => 'cancel', | |
184 | 'name' => ts('Cancel'), | |
185 | ), | |
186 | ); | |
187 | ||
188 | $this->addButtons($buttons); | |
189 | } | |
190 | ||
191 | public function postProcess() { | |
192 | $params = $ids = array(); | |
193 | $uploadParams = array('from_name'); | |
194 | ||
195 | $formValues = $this->controller->exportValues($this->_name); | |
196 | ||
197 | foreach ($uploadParams as $key) { | |
a7488080 | 198 | if (!empty($formValues[$key])) { |
6a488035 TO |
199 | $params[$key] = $formValues[$key]; |
200 | $this->set($key, $formValues[$key]); | |
201 | } | |
202 | } | |
203 | ||
204 | if (!$formValues['upload_type']) { | |
205 | $contents = NULL; | |
206 | if (isset($formValues['textFile']) && | |
207 | !empty($formValues['textFile']) | |
208 | ) { | |
209 | $contents = file_get_contents($formValues['textFile']['name']); | |
210 | $this->set($key, $formValues['textFile']['name']); | |
211 | } | |
212 | if ($contents) { | |
213 | $params['body_text'] = $contents; | |
214 | } | |
215 | else { | |
216 | $params['body_text'] = 'NULL'; | |
217 | } | |
218 | } | |
219 | else { | |
1e035d58 | 220 | $text_message = $formValues['sms_text_message']; |
6a488035 TO |
221 | $params['body_text'] = $text_message; |
222 | $this->set('textFile', $params['body_text']); | |
223 | $this->set('text_message', $params['body_text']); | |
224 | } | |
225 | ||
226 | $params['name'] = $this->get('name'); | |
227 | ||
228 | $session = CRM_Core_Session::singleton(); | |
229 | $params['contact_id'] = $session->get('userID'); | |
230 | $composeFields = array( | |
1e035d58 | 231 | 'SMStemplate', 'SMSsaveTemplate', |
232 | 'SMSupdateTemplate', 'SMSsaveTemplateName', | |
6a488035 TO |
233 | ); |
234 | $msgTemplate = NULL; | |
235 | //mail template is composed | |
236 | if ($formValues['upload_type']) { | |
237 | $composeParams = array(); | |
238 | foreach ($composeFields as $key) { | |
a7488080 | 239 | if (!empty($formValues[$key])) { |
6a488035 TO |
240 | $composeParams[$key] = $formValues[$key]; |
241 | $this->set($key, $formValues[$key]); | |
242 | } | |
243 | } | |
244 | ||
1e035d58 | 245 | if (!empty($composeParams['SMSupdateTemplate'])) { |
6a488035 TO |
246 | $templateParams = array( |
247 | 'msg_text' => $text_message, | |
248 | 'is_active' => TRUE, | |
1e035d58 | 249 | 'is_sms' => TRUE, |
6a488035 TO |
250 | ); |
251 | ||
1e035d58 | 252 | $templateParams['id'] = $formValues['SMStemplate']; |
6a488035 | 253 | |
c6327d7d | 254 | $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams); |
6a488035 TO |
255 | } |
256 | ||
1e035d58 | 257 | if (!empty($composeParams['SMSsaveTemplate'])) { |
6a488035 TO |
258 | $templateParams = array( |
259 | 'msg_text' => $text_message, | |
260 | 'is_active' => TRUE, | |
1e035d58 | 261 | 'is_sms' => TRUE, |
6a488035 TO |
262 | ); |
263 | ||
1e035d58 | 264 | $templateParams['msg_title'] = $composeParams['SMSsaveTemplateName']; |
6a488035 | 265 | |
c6327d7d | 266 | $msgTemplate = CRM_Core_BAO_MessageTemplate::add($templateParams); |
6a488035 TO |
267 | } |
268 | ||
269 | if (isset($msgTemplate->id)) { | |
270 | $params['msg_template_id'] = $msgTemplate->id; | |
271 | } | |
272 | else { | |
1e035d58 | 273 | $params['msg_template_id'] = CRM_Utils_Array::value('SMStemplate', $formValues); |
6a488035 TO |
274 | } |
275 | $this->set('template', $params['msg_template_id']); | |
276 | } | |
277 | ||
278 | $ids['mailing_id'] = $this->_mailingID; | |
279 | ||
280 | //get the from email address | |
281 | $params['sms_provider_id'] = $formValues['sms_provider_id']; | |
282 | ||
283 | //get the from Name | |
284 | $params['from_name'] = CRM_Core_DAO::getFieldValue('CRM_SMS_DAO_Provider', $params['sms_provider_id'], 'username'); | |
285 | ||
286 | //Build SMS in mailing table | |
287 | CRM_Mailing_BAO_Mailing::create($params, $ids); | |
288 | } | |
289 | ||
290 | /** | |
100fef9d | 291 | * Validation |
6a488035 TO |
292 | * |
293 | * @param array $params (ref.) an assoc array of name/value pairs | |
294 | * | |
77b97be7 EM |
295 | * @param $files |
296 | * @param $self | |
297 | * | |
6a488035 | 298 | * @return mixed true or array of errors |
6a488035 TO |
299 | * @static |
300 | */ | |
00be9182 | 301 | public static function formRule($params, $files, $self) { |
a7488080 | 302 | if (!empty($_POST['_qf_Import_refresh'])) { |
6a488035 TO |
303 | return TRUE; |
304 | } | |
305 | $errors = array(); | |
306 | $template = CRM_Core_Smarty::singleton(); | |
307 | ||
308 | ||
309 | $domain = CRM_Core_BAO_Domain::getDomain(); | |
310 | ||
311 | $mailing = new CRM_Mailing_BAO_Mailing(); | |
312 | $mailing->id = $self->_mailingID; | |
313 | $mailing->find(TRUE); | |
314 | ||
315 | $session = CRM_Core_Session::singleton(); | |
316 | $values = array('contact_id' => $session->get('userID'), | |
317 | 'version' => 3, | |
318 | ); | |
319 | require_once 'api/api.php'; | |
320 | $contact = civicrm_api('contact', 'get', $values); | |
321 | ||
322 | //CRM-4524 | |
323 | $contact = reset($contact['values']); | |
324 | ||
325 | $verp = array_flip(array('optOut', 'reply', 'unsubscribe', 'resubscribe', 'owner')); | |
326 | foreach ($verp as $key => $value) { | |
327 | $verp[$key]++; | |
328 | } | |
329 | ||
330 | $urls = array_flip(array('forward', 'optOutUrl', 'unsubscribeUrl', 'resubscribeUrl')); | |
331 | foreach ($urls as $key => $value) { | |
332 | $urls[$key]++; | |
333 | } | |
334 | ||
335 | ||
336 | $skipTextFile = $self->get('skipTextFile'); | |
337 | ||
338 | if (!$params['upload_type']) { | |
339 | if ((!isset($files['textFile']) || !file_exists($files['textFile']['tmp_name']))) { | |
340 | if (!($skipTextFile)) { | |
341 | $errors['textFile'] = ts('Please provide a Text'); | |
342 | } | |
343 | } | |
344 | } | |
345 | else { | |
1e035d58 | 346 | if (empty($params['sms_text_message'])) { |
347 | $errors['sms_text_message'] = ts('Please provide a Text'); | |
6a488035 TO |
348 | } |
349 | else { | |
a7488080 | 350 | if (!empty($params['text_message'])) { |
6a488035 TO |
351 | $messageCheck = CRM_Utils_Array::value('text_message', $params); |
352 | if ($messageCheck && (strlen($messageCheck) > CRM_SMS_Provider::MAX_SMS_CHAR)) { | |
353 | $errors['text_message'] = ts("You can configure the SMS message body up to %1 characters", array(1 => CRM_SMS_Provider::MAX_SMS_CHAR)); | |
354 | } | |
355 | } | |
356 | } | |
1e035d58 | 357 | if (!empty($params['SMSsaveTemplate']) && empty($params['SMSsaveTemplateName'])) { |
358 | $errors['SMSsaveTemplateName'] = ts('Please provide a Template Name.'); | |
6a488035 TO |
359 | } |
360 | } | |
361 | ||
362 | if (($params['upload_type'] || file_exists(CRM_Utils_Array::value('tmp_name', $files['textFile']))) || | |
363 | (!$params['upload_type'] && $params['text_message']) | |
364 | ) { | |
365 | ||
366 | if (!$params['upload_type']) { | |
367 | $str = file_get_contents($files['textFile']['tmp_name']); | |
368 | $name = $files['textFile']['name']; | |
369 | } | |
370 | else { | |
1e035d58 | 371 | $str = $params['sms_text_message']; |
6a488035 TO |
372 | $name = 'text message'; |
373 | } | |
374 | ||
375 | $dataErrors = array(); | |
376 | ||
377 | /* Do a full token replacement on a dummy verp, the current | |
378 | * contact and domain, and the first organization. */ | |
379 | ||
380 | ||
381 | // here we make a dummy mailing object so that we | |
382 | // can retrieve the tokens that we need to replace | |
383 | // so that we do get an invalid token error | |
384 | // this is qute hacky and I hope that there might | |
385 | // be a suggestion from someone on how to | |
386 | // make it a bit more elegant | |
387 | ||
388 | $dummy_mail = new CRM_Mailing_BAO_Mailing(); | |
389 | $mess = "body_text"; | |
390 | $dummy_mail->$mess = $str; | |
391 | $tokens = $dummy_mail->getTokens(); | |
392 | ||
393 | $str = CRM_Utils_Token::replaceSubscribeInviteTokens($str); | |
394 | $str = CRM_Utils_Token::replaceDomainTokens($str, $domain, NULL, $tokens['text']); | |
395 | $str = CRM_Utils_Token::replaceMailingTokens($str, $mailing, NULL, $tokens['text']); | |
396 | $str = CRM_Utils_Token::replaceOrgTokens($str, $org); | |
397 | $str = CRM_Utils_Token::replaceActionTokens($str, $verp, $urls, NULL, $tokens['text']); | |
398 | $str = CRM_Utils_Token::replaceContactTokens($str, $contact, NULL, $tokens['text']); | |
399 | ||
400 | $unmatched = CRM_Utils_Token::unmatchedTokens($str); | |
401 | $contentCheck = CRM_Utils_String::htmlToText($str); | |
402 | ||
403 | if (!empty($unmatched) && 0) { | |
404 | foreach ($unmatched as $token) { | |
405 | $dataErrors[] = '<li>' . ts('Invalid token code') . ' {' . $token . '}</li>'; | |
406 | } | |
407 | } | |
408 | if (strlen($contentCheck) > CRM_SMS_Provider::MAX_SMS_CHAR) { | |
409 | $dataErrors[] = '<li>' . ts('The body of the SMS cannot exceed %1 characters.', array(1 => CRM_SMS_Provider::MAX_SMS_CHAR)) . '</li>'; | |
410 | } | |
411 | if (!empty($dataErrors)) { | |
412 | $errors['textFile'] = ts('The following errors were detected in %1:', array( | |
413 | 1 => $name)) . ' <ul>' . implode('', $dataErrors) . '</ul>'; | |
414 | } | |
415 | } | |
416 | ||
c6327d7d | 417 | $templateName = CRM_Core_BAO_MessageTemplate::getMessageTemplates(); |
1e035d58 | 418 | if (!empty($params['SMSsaveTemplate']) && in_array(CRM_Utils_Array::value('SMSsaveTemplateName', $params), $templateName) |
6a488035 | 419 | ) { |
1e035d58 | 420 | $errors['SMSsaveTemplate'] = ts('Duplicate Template Name.'); |
6a488035 TO |
421 | } |
422 | return empty($errors) ? TRUE : $errors; | |
423 | } | |
424 | ||
425 | /** | |
426 | * Display Name of the form | |
427 | * | |
6a488035 TO |
428 | * |
429 | * @return string | |
430 | */ | |
431 | public function getTitle() { | |
432 | return ts('SMS Content'); | |
433 | } | |
434 | } |