305 lines
10 KiB
PHP
305 lines
10 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM 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 Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This class generates form components for Message templates
|
||
|
|
* used by membership, contributions, event registrations, etc.
|
||
|
|
*/
|
||
|
|
class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form {
|
||
|
|
// which (and whether) mailing workflow this template belongs to
|
||
|
|
protected $_workflow_id = NULL;
|
||
|
|
|
||
|
|
// Is document file is already loaded as default value?
|
||
|
|
protected $_is_document = FALSE;
|
||
|
|
|
||
|
|
public function preProcess() {
|
||
|
|
$this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
|
||
|
|
$this->_action = CRM_Utils_Request::retrieve('action', 'String',
|
||
|
|
$this, FALSE, 'add'
|
||
|
|
);
|
||
|
|
$this->assign('action', $this->_action);
|
||
|
|
|
||
|
|
$this->_BAOName = 'CRM_Core_BAO_MessageTemplate';
|
||
|
|
$this->set('BAOName', $this->_BAOName);
|
||
|
|
parent::preProcess();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set default values for the form.
|
||
|
|
*
|
||
|
|
* The default values are retrieved from the database.
|
||
|
|
*/
|
||
|
|
public function setDefaultValues() {
|
||
|
|
$defaults = $this->_values;
|
||
|
|
|
||
|
|
if (empty($defaults['pdf_format_id'])) {
|
||
|
|
$defaults['pdf_format_id'] = 'null';
|
||
|
|
}
|
||
|
|
if (empty($defaults['file_type'])) {
|
||
|
|
$defaults['file_type'] = 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->_action & CRM_Core_Action::ADD) {
|
||
|
|
$defaults['is_active'] = 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->_action & CRM_Core_Action::UPDATE) {
|
||
|
|
$documentInfo = CRM_Core_BAO_File::getEntityFile('civicrm_msg_template', $this->_id, TRUE);
|
||
|
|
if (!empty($documentInfo)) {
|
||
|
|
$defaults['file_type'] = 1;
|
||
|
|
$this->_is_document = TRUE;
|
||
|
|
$this->assign('attachment', $documentInfo);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $defaults;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Build the form object.
|
||
|
|
*/
|
||
|
|
public function buildQuickForm() {
|
||
|
|
// For VIEW we only want Done button
|
||
|
|
if ($this->_action & CRM_Core_Action::VIEW) {
|
||
|
|
// currently, the above action is used solely for previewing default workflow templates
|
||
|
|
$cancelURL = CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1');
|
||
|
|
$cancelURL = str_replace('&', '&', $cancelURL);
|
||
|
|
$this->addButtons(array(
|
||
|
|
array(
|
||
|
|
'type' => 'cancel',
|
||
|
|
'name' => ts('Done'),
|
||
|
|
'js' => array('onclick' => "location.href='{$cancelURL}'; return false;"),
|
||
|
|
'isDefault' => TRUE,
|
||
|
|
),
|
||
|
|
)
|
||
|
|
);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$this->_workflow_id = CRM_Utils_Array::value('workflow_id', $this->_values);
|
||
|
|
$this->assign('workflow_id', $this->_workflow_id);
|
||
|
|
|
||
|
|
if ($this->_workflow_id) {
|
||
|
|
$selectedChild = 'workflow';
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$selectedChild = 'user';
|
||
|
|
}
|
||
|
|
|
||
|
|
$cancelURL = CRM_Utils_System::url('civicrm/admin/messageTemplates', "selectedChild={$selectedChild}&reset=1");
|
||
|
|
$cancelURL = str_replace('&', '&', $cancelURL);
|
||
|
|
$buttons[] = array(
|
||
|
|
'type' => 'upload',
|
||
|
|
'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'),
|
||
|
|
'isDefault' => TRUE,
|
||
|
|
);
|
||
|
|
if (!($this->_action & CRM_Core_Action::DELETE)) {
|
||
|
|
$buttons[] = array(
|
||
|
|
'type' => 'submit',
|
||
|
|
'name' => ts('Save and Done'),
|
||
|
|
'subName' => 'done',
|
||
|
|
);
|
||
|
|
}
|
||
|
|
$buttons[] = array(
|
||
|
|
'type' => 'cancel',
|
||
|
|
'name' => ts('Cancel'),
|
||
|
|
'js' => array('onclick' => "location.href='{$cancelURL}'; return false;"),
|
||
|
|
);
|
||
|
|
$this->addButtons($buttons);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->_action & CRM_Core_Action::DELETE) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
$breadCrumb = array(
|
||
|
|
array(
|
||
|
|
'title' => ts('Message Templates'),
|
||
|
|
'url' => CRM_Utils_System::url('civicrm/admin/messageTemplates',
|
||
|
|
'action=browse&reset=1'
|
||
|
|
),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
CRM_Utils_System::appendBreadCrumb($breadCrumb);
|
||
|
|
|
||
|
|
$this->applyFilter('__ALL__', 'trim');
|
||
|
|
$this->add('text', 'msg_title', ts('Message Title'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_MessageTemplate', 'msg_title'), TRUE);
|
||
|
|
|
||
|
|
$options = array(ts('Compose On-screen'), ts('Upload Document'));
|
||
|
|
$element = $this->addRadio('file_type', ts('Source'), $options);
|
||
|
|
if ($this->_id) {
|
||
|
|
$element->freeze();
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->addElement('file', "file_id", ts('Upload Document'), 'size=30 maxlength=255');
|
||
|
|
$this->addUploadElement("file_id");
|
||
|
|
|
||
|
|
$this->add('text', 'msg_subject',
|
||
|
|
ts('Message Subject'),
|
||
|
|
CRM_Core_DAO::getAttribute('CRM_Core_DAO_MessageTemplate', 'msg_subject')
|
||
|
|
);
|
||
|
|
|
||
|
|
//get the tokens.
|
||
|
|
$tokens = CRM_Core_SelectValues::contactTokens();
|
||
|
|
|
||
|
|
$this->assign('tokens', CRM_Utils_Token::formatTokensForDisplay($tokens));
|
||
|
|
|
||
|
|
// if not a system message use a wysiwyg editor, CRM-5971
|
||
|
|
if ($this->_id &&
|
||
|
|
CRM_Core_DAO::getFieldValue('CRM_Core_DAO_MessageTemplate',
|
||
|
|
$this->_id,
|
||
|
|
'workflow_id'
|
||
|
|
)
|
||
|
|
) {
|
||
|
|
$this->add('textarea', 'msg_html', ts('HTML Message'),
|
||
|
|
"cols=50 rows=6"
|
||
|
|
);
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$this->add('wysiwyg', 'msg_html', ts('HTML Message'),
|
||
|
|
array(
|
||
|
|
'cols' => '80',
|
||
|
|
'rows' => '8',
|
||
|
|
'onkeyup' => "return verify(this)",
|
||
|
|
'preset' => 'civimail',
|
||
|
|
)
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->add('textarea', 'msg_text', ts('Text Message'),
|
||
|
|
"cols=50 rows=6"
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->add('select', 'pdf_format_id', ts('PDF Page Format'),
|
||
|
|
array(
|
||
|
|
'null' => ts('- default -'),
|
||
|
|
) + CRM_Core_BAO_PdfFormat::getList(TRUE), FALSE
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->add('checkbox', 'is_active', ts('Enabled?'));
|
||
|
|
$this->addFormRule(array(__CLASS__, 'formRule'), $this);
|
||
|
|
|
||
|
|
if ($this->_action & CRM_Core_Action::VIEW) {
|
||
|
|
$this->freeze();
|
||
|
|
CRM_Utils_System::setTitle(ts('View System Default Message Template'));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Global form rule.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* The input form values.
|
||
|
|
* @param array $files
|
||
|
|
* The uploaded files if any.
|
||
|
|
* @param array $self
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* array of errors
|
||
|
|
*/
|
||
|
|
public static function formRule($params, $files, $self) {
|
||
|
|
// If user uploads non-document file other than odt/docx
|
||
|
|
if (!empty($files['file_id']['tmp_name']) &&
|
||
|
|
array_search($files['file_id']['type'], CRM_Core_SelectValues::documentApplicationType()) == NULL
|
||
|
|
) {
|
||
|
|
$errors['file_id'] = ts('Invalid document file format');
|
||
|
|
}
|
||
|
|
// If default is not set and no document file is uploaded
|
||
|
|
elseif (empty($files['file_id']['tmp_name']) && !empty($params['file_type']) && !$self->_is_document) {
|
||
|
|
//On edit page of docx/odt message template if user changes file type but forgot to upload document
|
||
|
|
$errors['file_id'] = ts('Please upload document');
|
||
|
|
}
|
||
|
|
|
||
|
|
return empty($errors) ? TRUE : $errors;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Process the form submission.
|
||
|
|
*/
|
||
|
|
public function postProcess() {
|
||
|
|
if ($this->_action & CRM_Core_Action::DELETE) {
|
||
|
|
CRM_Core_BAO_MessageTemplate::del($this->_id);
|
||
|
|
}
|
||
|
|
elseif ($this->_action & CRM_Core_Action::VIEW) {
|
||
|
|
// currently, the above action is used solely for previewing default workflow templates
|
||
|
|
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1'));
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
// store the submitted values in an array
|
||
|
|
$params = $this->controller->exportValues();
|
||
|
|
|
||
|
|
if ($this->_action & CRM_Core_Action::UPDATE) {
|
||
|
|
$params['id'] = $this->_id;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($params['file_type'])) {
|
||
|
|
unset($params['msg_html']);
|
||
|
|
unset($params['msg_text']);
|
||
|
|
CRM_Utils_File::formatFile($params, 'file_id');
|
||
|
|
}
|
||
|
|
// delete related file references if html/text/pdf template are chosen over document
|
||
|
|
elseif (!empty($this->_id)) {
|
||
|
|
$entityFileDAO = new CRM_Core_DAO_EntityFile();
|
||
|
|
$entityFileDAO->entity_id = $this->_id;
|
||
|
|
$entityFileDAO->entity_table = 'civicrm_msg_template';
|
||
|
|
if ($entityFileDAO->find(TRUE)) {
|
||
|
|
$fileDAO = new CRM_Core_DAO_File();
|
||
|
|
$fileDAO->id = $entityFileDAO->file_id;
|
||
|
|
$fileDAO->find(TRUE);
|
||
|
|
$entityFileDAO->delete();
|
||
|
|
$fileDAO->delete();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->_workflow_id = CRM_Utils_Array::value('workflow_id', $this->_values);
|
||
|
|
if ($this->_workflow_id) {
|
||
|
|
$params['workflow_id'] = $this->_workflow_id;
|
||
|
|
$params['is_active'] = TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
$messageTemplate = CRM_Core_BAO_MessageTemplate::add($params);
|
||
|
|
CRM_Core_Session::setStatus(ts('The Message Template \'%1\' has been saved.', array(1 => $messageTemplate->msg_title)), ts('Saved'), 'success');
|
||
|
|
|
||
|
|
if (isset($this->_submitValues['_qf_MessageTemplates_upload'])) {
|
||
|
|
// Save button was pressed
|
||
|
|
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates/add', "action=update&id={$messageTemplate->id}&reset=1"));
|
||
|
|
}
|
||
|
|
// Save and done button was pressed
|
||
|
|
if ($this->_workflow_id) {
|
||
|
|
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1'));
|
||
|
|
}
|
||
|
|
CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/messageTemplates', 'selectedChild=user&reset=1'));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|