3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This file is used to build the form configuring mass sms details
39 class CRM_SMS_Form_Upload
extends CRM_Core_Form
{
42 function preProcess() {
43 $this->_mailingID
= $this->get('mailing_id');
44 if (CRM_Core_Permission
::check('administer CiviCRM')) {
45 $this->assign('isAdmin', 1);
50 * This function sets the default values for the form.
51 * the default values are retrieved from the database
57 function setDefaultValues() {
58 $mailingID = CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE, NULL);
60 //need to differentiate new/reuse mailing, CRM-2873
61 $reuseMailing = FALSE;
66 $mailingID = $this->_mailingID
;
69 $count = $this->get('count');
70 $this->assign('count', $count);
72 $this->set('skipTextFile', FALSE);
77 $dao = new CRM_Mailing_DAO_Mailing();
78 $dao->id
= $mailingID;
80 $dao->storeValues($dao, $defaults);
82 //we don't want to retrieve template details once it is
84 $templateId = $this->get('template');
85 $this->assign('templateSelected', $templateId ?
$templateId : 0);
86 if (isset($defaults['msg_template_id']) && !$templateId) {
87 $defaults['template'] = $defaults['msg_template_id'];
88 $messageTemplate = new CRM_Core_DAO_MessageTemplate();
89 $messageTemplate->id
= $defaults['msg_template_id'];
90 $messageTemplate->selectAdd();
91 $messageTemplate->selectAdd('msg_text');
92 $messageTemplate->find(TRUE);
94 $defaults['text_message'] = $messageTemplate->msg_text
;
97 if (isset($defaults['body_text'])) {
98 $defaults['text_message'] = $defaults['body_text'];
99 $this->set('textFile', $defaults['body_text']);
100 $this->set('skipTextFile', TRUE);
105 if (!$reuseMailing) {
106 $textFilePath = $this->get('textFilePath');
108 file_exists($textFilePath)
110 $defaults['text_message'] = file_get_contents($textFilePath);
111 if (strlen($defaults['text_message']) > 0) {
112 $this->set('skipTextFile', TRUE);
117 $defaults['upload_type'] = 1;
123 * Function to actually build the form
128 public function buildQuickForm() {
129 $session = CRM_Core_Session
::singleton();
130 $config = CRM_Core_Config
::singleton();
134 $this->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
136 // this seems so hacky, not sure what we are doing here and why. Need to investigate and fix
137 $session->getVars($options,
138 "CRM_SMS_Controller_Send_{$this->controller->_key}"
141 $providers = CRM_SMS_BAO_Provider
::getProviders(array('id', 'title'));
143 if (empty($providers)) {
144 //redirect user to configure sms provider.
145 $url = CRM_Utils_System
::url('civicrm/admin/sms/provider', 'action=add&reset=1');
146 $status = ts("There is no SMS Provider Configured. You can add here <a href='%1'>Add SMS Provider</a>", array(1 => $url));
147 $session->setStatus($status);
150 $providerSelect[''] = '- select -';
151 foreach ($providers as $provider) {
152 $providerSelect[$provider['id']] = $provider['title'];
156 $this->add('select', 'sms_provider_id',
157 ts('SMS Provider'), $providerSelect, TRUE
160 $attributes = array('onclick' => "showHideUpload();");
161 $options = array(ts('Upload Content'), ts('Compose On-screen'));
163 $this->addRadio('upload_type', ts('I want to'), $options, $attributes, " ");
165 CRM_Mailing_BAO_Mailing
::commonCompose($this);
167 $this->addElement('file', 'textFile', ts('Upload TEXT Message'), 'size=30 maxlength=60');
168 $this->setMaxFileSize(1024 * 1024);
169 $this->addRule('textFile', ts('File size should be less than 1 MByte'), 'maxfilesize', 1024 * 1024);
170 $this->addRule('textFile', ts('File must be in UTF-8 encoding'), 'utf8File');
172 $this->addFormRule(array('CRM_SMS_Form_Upload', 'formRule'), $this);
175 array('type' => 'back',
176 'name' => ts('<< Previous'),
180 'name' => ts('Next >>'),
181 'spacing' => ' ',
186 'name' => ts('Cancel'),
190 $this->addButtons($buttons);
193 public function postProcess() {
194 $params = $ids = array();
195 $uploadParams = array('from_name');
197 $formValues = $this->controller
->exportValues($this->_name
);
199 foreach ($uploadParams as $key) {
200 if (!empty($formValues[$key])) {
201 $params[$key] = $formValues[$key];
202 $this->set($key, $formValues[$key]);
206 if (!$formValues['upload_type']) {
208 if (isset($formValues['textFile']) &&
209 !empty($formValues['textFile'])
211 $contents = file_get_contents($formValues['textFile']['name']);
212 $this->set($key, $formValues['textFile']['name']);
215 $params['body_text'] = $contents;
218 $params['body_text'] = 'NULL';
222 $text_message = $formValues['text_message'];
223 $params['body_text'] = $text_message;
224 $this->set('textFile', $params['body_text']);
225 $this->set('text_message', $params['body_text']);
228 $params['name'] = $this->get('name');
230 $session = CRM_Core_Session
::singleton();
231 $params['contact_id'] = $session->get('userID');
232 $composeFields = array(
233 'template', 'saveTemplate',
234 'updateTemplate', 'saveTemplateName',
237 //mail template is composed
238 if ($formValues['upload_type']) {
239 $composeParams = array();
240 foreach ($composeFields as $key) {
241 if (!empty($formValues[$key])) {
242 $composeParams[$key] = $formValues[$key];
243 $this->set($key, $formValues[$key]);
247 if (!empty($composeParams['updateTemplate'])) {
248 $templateParams = array(
249 'msg_text' => $text_message,
253 $templateParams['id'] = $formValues['template'];
255 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
258 if (!empty($composeParams['saveTemplate'])) {
259 $templateParams = array(
260 'msg_text' => $text_message,
264 $templateParams['msg_title'] = $composeParams['saveTemplateName'];
266 $msgTemplate = CRM_Core_BAO_MessageTemplate
::add($templateParams);
269 if (isset($msgTemplate->id
)) {
270 $params['msg_template_id'] = $msgTemplate->id
;
273 $params['msg_template_id'] = CRM_Utils_Array
::value('template', $formValues);
275 $this->set('template', $params['msg_template_id']);
278 $ids['mailing_id'] = $this->_mailingID
;
280 //get the from email address
281 $params['sms_provider_id'] = $formValues['sms_provider_id'];
284 $params['from_name'] = CRM_Core_DAO
::getFieldValue('CRM_SMS_DAO_Provider', $params['sms_provider_id'], 'username');
286 //Build SMS in mailing table
287 CRM_Mailing_BAO_Mailing
::create($params, $ids);
291 * Function for validation
293 * @param array $params (ref.) an assoc array of name/value pairs
295 * @return mixed true or array of errors
299 static function formRule($params, $files, $self) {
300 if (!empty($_POST['_qf_Import_refresh'])) {
304 $template = CRM_Core_Smarty
::singleton();
307 $domain = CRM_Core_BAO_Domain
::getDomain();
309 $mailing = new CRM_Mailing_BAO_Mailing();
310 $mailing->id
= $self->_mailingID
;
311 $mailing->find(TRUE);
313 $session = CRM_Core_Session
::singleton();
314 $values = array('contact_id' => $session->get('userID'),
317 require_once 'api/api.php';
318 $contact = civicrm_api('contact', 'get', $values);
321 $contact = reset($contact['values']);
323 $verp = array_flip(array('optOut', 'reply', 'unsubscribe', 'resubscribe', 'owner'));
324 foreach ($verp as $key => $value) {
328 $urls = array_flip(array('forward', 'optOutUrl', 'unsubscribeUrl', 'resubscribeUrl'));
329 foreach ($urls as $key => $value) {
334 $skipTextFile = $self->get('skipTextFile');
336 if (!$params['upload_type']) {
337 if ((!isset($files['textFile']) ||
!file_exists($files['textFile']['tmp_name']))) {
338 if (!($skipTextFile)) {
339 $errors['textFile'] = ts('Please provide a Text');
344 if (empty($params['text_message'])) {
345 $errors['text_message'] = ts('Please provide a Text');
348 if (!empty($params['text_message'])) {
349 $messageCheck = CRM_Utils_Array
::value('text_message', $params);
350 if ($messageCheck && (strlen($messageCheck) > CRM_SMS_Provider
::MAX_SMS_CHAR
)) {
351 $errors['text_message'] = ts("You can configure the SMS message body up to %1 characters", array(1 => CRM_SMS_Provider
::MAX_SMS_CHAR
));
355 if (!empty($params['saveTemplate']) && empty($params['saveTemplateName'])) {
356 $errors['saveTemplateName'] = ts('Please provide a Template Name.');
360 if (($params['upload_type'] ||
file_exists(CRM_Utils_Array
::value('tmp_name', $files['textFile']))) ||
361 (!$params['upload_type'] && $params['text_message'])
364 if (!$params['upload_type']) {
365 $str = file_get_contents($files['textFile']['tmp_name']);
366 $name = $files['textFile']['name'];
369 $str = $params['text_message'];
370 $name = 'text message';
373 $dataErrors = array();
375 /* Do a full token replacement on a dummy verp, the current
376 * contact and domain, and the first organization. */
379 // here we make a dummy mailing object so that we
380 // can retrieve the tokens that we need to replace
381 // so that we do get an invalid token error
382 // this is qute hacky and I hope that there might
383 // be a suggestion from someone on how to
384 // make it a bit more elegant
386 $dummy_mail = new CRM_Mailing_BAO_Mailing();
388 $dummy_mail->$mess = $str;
389 $tokens = $dummy_mail->getTokens();
391 $str = CRM_Utils_Token
::replaceSubscribeInviteTokens($str);
392 $str = CRM_Utils_Token
::replaceDomainTokens($str, $domain, NULL, $tokens['text']);
393 $str = CRM_Utils_Token
::replaceMailingTokens($str, $mailing, NULL, $tokens['text']);
394 $str = CRM_Utils_Token
::replaceOrgTokens($str, $org);
395 $str = CRM_Utils_Token
::replaceActionTokens($str, $verp, $urls, NULL, $tokens['text']);
396 $str = CRM_Utils_Token
::replaceContactTokens($str, $contact, NULL, $tokens['text']);
398 $unmatched = CRM_Utils_Token
::unmatchedTokens($str);
399 $contentCheck = CRM_Utils_String
::htmlToText($str);
401 if (!empty($unmatched) && 0) {
402 foreach ($unmatched as $token) {
403 $dataErrors[] = '<li>' . ts('Invalid token code') . ' {' . $token . '}</li>';
406 if (strlen($contentCheck) > CRM_SMS_Provider
::MAX_SMS_CHAR
) {
407 $dataErrors[] = '<li>' . ts('The body of the SMS cannot exceed %1 characters.', array(1 => CRM_SMS_Provider
::MAX_SMS_CHAR
)) . '</li>';
409 if (!empty($dataErrors)) {
410 $errors['textFile'] = ts('The following errors were detected in %1:', array(
411 1 => $name)) . ' <ul>' . implode('', $dataErrors) . '</ul>';
415 $templateName = CRM_Core_BAO_MessageTemplate
::getMessageTemplates();
416 if (!empty($params['saveTemplate']) && in_array(CRM_Utils_Array
::value('saveTemplateName', $params), $templateName)
418 $errors['saveTemplate'] = ts('Duplicate Template Name.');
420 return empty($errors) ?
TRUE : $errors;
424 * Display Name of the form
430 public function getTitle() {
431 return ts('SMS Content');