Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mail Merge in MS Excel & LibreOffice Calc #30

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Mail Merge in MS Excel & LibreOffice Calc #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9fa3d69
developed mail merge with LibreOffice
asha15 Jun 15, 2020
5178321
changed merged file name
asha15 Jul 29, 2020
6aa933f
mail merge in MS Excel
asha15 Jul 29, 2020
f87630f
mail merge in LibreOffice Calc
asha15 Jul 29, 2020
2db2715
LibreCalc sample template
asha15 Jul 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
314 changes: 314 additions & 0 deletions CRM/Wordmailmerge/Form/LibreOfficeCalcMailMergeForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,314 @@
<?php

require_once 'CRM/Core/Form.php';

/**
* Form controller class
*
* @see https://docs.civicrm.org/dev/en/latest/framework/quickform/
*/
class CRM_Wordmailmerge_Form_LibreOfficeCalcMailMergeForm extends CRM_Contribute_Form_Task {
CONST TOKEN_VAR_NAME = "CiviCRM";
static protected $_searchFormValues;
function preProcess() {
//get all preProcessCommon Values
self::preProcessCommon($this);
$token = CRM_Core_SelectValues::contributionTokens();

//Membership Tokens
if ($this->_searchFrom == 'member') {
$token = $token + CRM_Core_SelectValues::membershipTokens();
}

$tokenMerge = array();
foreach ($token as $key => $label) {
$tokenMerge [] = array(
'id' => $key,
'text' => $label,
);
}
//construct array to manage token name and label
foreach ($tokenMerge as $tmKey => $tmValue) {
$tokenFullName = str_replace(array('{','}'),"",$tmValue['id']); //romving the curly bracket -Asha
$explodedTokenName = explode('.', $tokenFullName); // removing the contribution part - Asha

$tokenMerge[$tmKey]['token_name'] = ($explodedTokenName[0] != 'contribution') ? $tokenFullName : $explodedTokenName[1];
if ($explodedTokenName[0] != 'civiqrcode'){
if ($explodedTokenName[0] != 'contribution') {
$tokenMerge[$tmKey]['var_name'] = '['.self::TOKEN_VAR_NAME.'.'.$tokenFullName.';block=tbs:row]';
$tokenMerge[$tmKey]['var_name_table'] = '['.self::TOKEN_VAR_NAME.'.'.$tokenFullName.';block=tbs:table]';
}
else {
$tokenMerge[$tmKey]['var_name'] = '['.self::TOKEN_VAR_NAME.'.'.$explodedTokenName[1].';block=tbs:row]';
$tokenMerge[$tmKey]['var_name_table'] = '['.self::TOKEN_VAR_NAME.'.'.$explodedTokenName[1].';block=tbs:table]';
}
}
else {
$tokenMerge[$tmKey]['var_name'] = '['.self::TOKEN_VAR_NAME.'.'.$tokenFullName.';block=w:image;ope=changepic]';
$tokenMerge[$tmKey]['var_name_table'] = '['.self::TOKEN_VAR_NAME.'.'.$tokenFullName.';block=w:image;ope=changepic]';
}
$this->_allTokens[$explodedTokenName[0]][] = $explodedTokenName[1];
$this->_returnProperties[$explodedTokenName[1]] = 1;
}

$this->_tokenMerge = $tokenMerge;
$this->assign('availableTokens', $this->_tokenMerge);

}

static function preProcessCommon(&$form, $useTable = true) {
$form->_contributionIds = array();
$form->_contributionTypes = array();
$form->_searchFrom = $searchformName = 'contribution';

$searchFrom = $form->get('searchFormName');

$pages = $form->controller->_pages;
$prefix = 'contribution';
if ($pages[$searchFrom]) {
$prefix = $pages[$searchFrom]->getVar('_prefix');
if ($prefix == 'member_') {
$searchformName = 'member';
}
}

if ($searchformName == 'member') {
$form->_searchFrom = $searchformName;
$values = $form->controller->exportValues($form->get('searchFormName'));
$ids = array();
if ($values['radio_ts'] == 'ts_sel') {
foreach ($values as $name => $value) {
if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
$ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
}
}
}
else {
$queryParams = $form->get('queryParams');
$sortOrder = null;
if ( $form->get( CRM_Utils_Sort::SORT_ORDER ) ) {
$sortOrder = $form->get( CRM_Utils_Sort::SORT_ORDER );
}
$query = new CRM_Contribute_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
CRM_Contribute_BAO_Query::MODE_MEMBER
);
$query->_distinctComponentClause = ' civicrm_membership.id';
$query->_groupByComponentClause = ' GROUP BY civicrm_membership.id ';
$result = $query->searchQuery(0, 0, $sortOrder);

while ($result->fetch()) {
$ids[] = $result->membership_id;
}
}

if (!empty($ids)) {
$form->_componentClause = ' civicrm_membership.id IN ( ' . implode(',', $ids) . ' ) ';
$form->assign('totalSelectedMembers', count($ids));
}

$form->_memberIds = $form->_componentIds = $ids;
$form->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($ids,'civicrm_membership');
$form->assign('totalSelectedContacts', count($form->_contactIds));
}
else {
parent::preProcessCommon($form);
}
}

function buildQuickForm() {
$mysql = 'SELECT id FROM veda_civicrm_excelmailmerge';
$tableCount = CRM_Core_DAO::executeQuery($mysql);
$noofRows = array();
while ($tableCount->fetch()) {
$noofRows[] = $tableCount->id;
}
$rowCount = count((array)$noofRows);
if( $rowCount == 0){
$this->add('select', 'message_template', ts('Message Template'), array('' => '- select -'), TRUE);
CRM_Core_Session::setStatus(ts("No attachement in the template."));
}else{
$sql = "SELECT id, template_title FROM veda_civicrm_excelmailmerge where mailmerge_option_id = 1 and is_active = 1";
$dao = CRM_Core_DAO::executeQuery($sql);
while ($dao->fetch()) {
$templatesResult[$dao->id] = $dao->template_title;
}
// add form elements
$this->add('select', 'message_template', ts('Message Template'), array('' => '- select -') + $templatesResult, TRUE);


$this->addButtons(array(
array(
'type' => 'back',
'name' => ts('Back'),
'class' => 'wm-back',
'spacing' => '&nbsp;&nbsp;&nbsp;',
'isDefault' => TRUE,
),
array(
'type' => 'submit',
'name' => ts('Print Letters'),
'class' => 'wm-print-letters',
'spacing' => '&nbsp;&nbsp;&nbsp;',
'isDefault' => TRUE,
),
array(
'type' => 'cancel',
'name' => ts('Done'),
'class' => 'wm-done',
'spacing' => '&nbsp;&nbsp;&nbsp;',
'isDefault' => TRUE,
),
));
}
// export form elements
$this->assign('elementNames', $this->getRenderableElementNames());

}

function postProcess() {
$values = $this->_contributionIds;
$config = CRM_Core_Config::singleton();
$msg_id = $this->_submitValues['message_template'];
if(!empty($msg_id)){
$mysql = " SELECT * FROM veda_civicrm_excelmailmerge WHERE id = %1";
$params = array(1 => array($msg_id, 'Integer'));
$dao = CRM_Core_DAO::executeQuery($mysql, $params);
//$dao = CRM_Core_DAO::executeQuery($mysql);
while ($dao->fetch()) {
$fileId = $dao->file_id;
}
$sql = "SELECT * FROM civicrm_file WHERE id = %1";
$params = array(1 => array($fileId, 'Integer'));
$dao = CRM_Core_DAO::executeQuery($sql, $params);
//$dao = CRM_Core_DAO::executeQuery($sql);
while ($dao->fetch()) {
$default['fileID'] = $dao->id;
$default['mime_type'] = $dao->mime_type;
$default['fileName'] = $dao->uri;
$default['cleanName'] = CRM_Utils_File::cleanFileName($dao->uri);
$default['fullPath'] = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $dao->uri;
$default['deleteURLArgs'] = CRM_Core_BAO_File::deleteURLArgs('civicrm_file', $msg_id, $dao->id);
}

$defaults[$dao->id] = $default;
$this->assign('defaults', $defaults);
$noofContribution = count($this->_contributionIds);
require_once $config->extensionsDir.'/uk.co.vedaconsulting.module.wordmailmerge/tinybutstrong/tbs_class.php';
require_once $config->extensionsDir.'/uk.co.vedaconsulting.module.wordmailmerge/tinybutstrong-opentbs/tbs_plugin_opentbs.php';
$TBS = new clsTinyButStrong; // new instance of TBS
$TBS->Plugin(TBS_INSTALL, OPENTBS_PLUGIN); // load the OpenTBS plugin
$template = $default['fullPath'];

// contributionrows to check for duplicate address
$contributionrows = array();
foreach ($values as $key => $value){
$SelectedContributionID = $values[$key];

// get the details for all selected contributions
$contributionDetails = civicrm_api3('Contribution', 'getsingle', ['id' => $SelectedContributionID]);

// populate contributionrows array to check dupliacte address
$contributionrows[$SelectedContributionID] = $contributionDetails;
}

foreach ($values as $key => $value) {
if($key < $noofContribution){
$selectedCID = $values[$key];
$contributionFormatted = array();
// if contact_id found in filtered contributionrows array get contribution details from contributionrows
if (array_key_exists($selectedCID, $contributionrows)) {
$contributionFormatted[$selectedCID] = $contributionrows[$selectedCID];

$membershipFormatted = array();
if ($this->_searchFrom == 'member' && isset($contributionFormatted[$selectedCID]['membership_id'])) {
$membershipFormatted = CRM_Utils_Token::getMembershipTokenDetails($contributionFormatted[$selectedCID]['membership_id']);
}

foreach ($this->_tokenMerge as $atKey => $atValue) {

// Replace hook tokens
$explodedTokenName = explode('.', $atValue['token_name']);

if (array_key_exists($atValue['token_name'], $contributionFormatted[$selectedCID]) ) {
if (!empty($explodedTokenName[1]) && $explodedTokenName[0] != 'contact') {
$vars[$key][$explodedTokenName[0]][$explodedTokenName[1]] = $contributionFormatted[$selectedCID][$atValue['token_name']];
}
else{
$vars[$key][$atValue['token_name']] = $contributionFormatted[$selectedCID][$atValue['token_name']];
}
}
else {
if ($explodedTokenName[0] == 'membership') {
$explodedTokenName[1] = ($explodedTokenName[1] == 'membership_id') ? 'id' : $explodedTokenName[1];
$vars[$key][$explodedTokenName[0]][$explodedTokenName[1]] = CRM_Utils_Token::getMembershipTokenReplacement($explodedTokenName[1], $membershipFormatted[$contributionFormatted[$selectedCID]['membership_id']]);
}
else {
$vars[$key][$atValue['token_name']] = CRM_Utils_Token::getContactTokenReplacement($atValue['token_name'], $contributionFormatted[$selectedCID], FALSE, FALSE);
}
}

//need to do proper fix, token_name.date seems not returning null value if not found
if ($explodedTokenName[0] == 'token_name' && !is_array($vars[$key]['token_name'])) {
$vars[$key][$atValue['token_name']] = '';
}
}

//to skip error, if by chance using membership token in 'find contribution' search
if ($this->_searchFrom != 'member') {
foreach (CRM_Core_SelectValues::membershipTokens() as $token => $label) {
$token = str_replace(array('{','}'),"",$token);
$tokenNames = explode('.', $token);
$vars[$key]['membership'][$tokenNames[1]] = $label;
}
}

foreach ($vars[$key] as $varKey => $varValue) {
$explodeValues = explode('.', $varKey);
if (isset($explodeValues[1]) && !empty($explodeValues[1])) {
$vars[$key][$explodeValues[0]][$explodeValues[1]] = $vars[$key][$varKey];
unset($vars[$key][$varKey]);
}
}

$TBS->LoadTemplate($template, OPENTBS_ALREADY_UTF8);
$TBS->MergeBlock(self::TOKEN_VAR_NAME,$vars);
}
}
}

$output_file_name = 'CiviCRMLOCalcExport.ods';
$TBS->Show(OPENTBS_DOWNLOAD, $output_file_name);
// GK - record wordmailmerge as activity
$recordActivity = CRM_Wordmailmerge_Utils::recordActivity($values);
CRM_Utils_System::civiExit();
}
parent::postProcess();
}

function getContact($selectedCID) {
$result = civicrm_api3('Contact', 'getsingle', array(
'sequential' => 1,
'contact_id' => $selectedCID,
));
return $result;
}
/**
* Get the fields/elements defined in this form.
*
* @return array (string)
*/
function getRenderableElementNames() {
// The _elements list includes some items which should not be
// auto-rendered in the loop -- such as "qfKey" and "buttons". These
// items don't have labels. We'll identify renderable by filtering on
// the 'label'.
$elementNames = array();
foreach ($this->_elements as $element) {
$label = $element->getLabel();
if (!empty($label)) {
$elementNames[] = $element->getName();
}
}
return $elementNames;
}
}
Loading