* @copyright 2007-2013 PrestaShop SA
* @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
if (!defined('_PS_VERSION_'))
exit;
class Followup extends Module
{
function __construct()
{
$this->name = 'followup';
$this->tab = 'advertising_marketing';
$this->version = '1.0';
$this->author = 'PrestaShop';
$this->need_instance = 0;
$this->confKeys = array(
'PS_FOLLOW_UP_ENABLE_1', 'PS_FOLLOW_UP_ENABLE_2', 'PS_FOLLOW_UP_ENABLE_3', 'PS_FOLLOW_UP_ENABLE_4',
'PS_FOLLOW_UP_AMOUNT_1', 'PS_FOLLOW_UP_AMOUNT_2', 'PS_FOLLOW_UP_AMOUNT_3', 'PS_FOLLOW_UP_AMOUNT_4',
'PS_FOLLOW_UP_DAYS_1', 'PS_FOLLOW_UP_DAYS_2', 'PS_FOLLOW_UP_DAYS_3', 'PS_FOLLOW_UP_DAYS_4',
'PS_FOLLOW_UP_THRESHOLD_3',
'PS_FOLLOW_UP_DAYS_THRESHOLD_4',
'PS_FOLLOW_UP_CLEAN_DB');
parent::__construct();
$this->displayName = $this->l('Customer follow-up');
$this->description = $this->l('Follow-up with your customers with daily customized e-mails.');
$this->confirmUninstall = $this->l('Are you sure you want to delete all settings and your logs?');
}
public function install()
{
$logEmailTable = Db::getInstance()->execute('
CREATE TABLE '._DB_PREFIX_.'log_email (
`id_log_email` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY ,
`id_email_type` INT UNSIGNED NOT NULL ,
`id_cart_rule` INT UNSIGNED NOT NULL ,
`id_customer` INT UNSIGNED NULL ,
`id_cart` INT UNSIGNED NULL ,
`date_add` DATETIME NOT NULL,
INDEX `date_add`(`date_add`),
INDEX `id_cart`(`id_cart`)
) ENGINE='._MYSQL_ENGINE_);
foreach ($this->confKeys AS $key)
Configuration::updateValue($key, 0);
Configuration::updateValue('PS_FOLLOWUP_SECURE_KEY', strtoupper(Tools::passwdGen(16)));
return parent::install();
}
public function uninstall()
{
foreach ($this->confKeys AS $key)
Configuration::deleteByName($key);
Configuration::deleteByName('PS_FOLLOWUP_SECURE_KEY');
Db::getInstance()->execute('DROP TABLE '._DB_PREFIX_.'log_email');
return parent::uninstall();
}
public function getContent()
{
$html = '';
/* Save settings */
if (Tools::isSubmit('submitFollowUp'))
foreach ($this->confKeys AS $c)
Configuration::updateValue($c, (float)(Tools::getValue($c)));
/* Init */
$conf = Configuration::getMultiple($this->confKeys);
foreach ($this->confKeys AS $k)
if (!isset($conf[$k]))
$conf[$k] = '';
$currency = new Currency((int)(Configuration::get('PS_CURRENCY_DEFAULT')));
$n1 = $this->cancelledCart(true);
$n2 = $this->reOrder(true);
$n3 = $this->bestCustomer(true);
$n4 = $this->badCustomer(true);
$html .= '
'.$this->l('Customer follow-up').'
';
return $html;
}
/* Log each sent e-mail */
private function logEmail($id_email_type, $id_cart_rule, $id_customer = NULL, $id_cart = NULL)
{
$values = array('id_email_type' => (int)($id_email_type), 'id_cart_rule' => (int)$id_cart_rule, 'date_add' => date('Y-m-d H:i:s'));
if (!empty($id_cart))
$values['id_cart'] = (int)($id_cart);
if (!empty($id_customer))
$values['id_customer'] = (int)($id_customer);
Db::getInstance()->insert('log_email', $values);
}
/* Each cart which wasn't transformed into an order */
private function cancelledCart($count = false)
{
$emailLogs = $this->getLogsEmail(1);
$sql = '
SELECT c.id_cart, c.id_lang, cu.id_customer, cu.firstname, cu.lastname, cu.email
FROM '._DB_PREFIX_.'cart c
LEFT JOIN '._DB_PREFIX_.'orders o ON (o.id_cart = c.id_cart)
RIGHT JOIN '._DB_PREFIX_.'customer cu ON (cu.id_customer = c.id_customer)
RIGHT JOIN '._DB_PREFIX_.'cart_product cp ON (cp.id_cart = c.id_cart)
WHERE DATE_SUB(CURDATE(),INTERVAL 7 DAY) <= c.date_add AND o.id_order IS NULL';
if(!empty($emailLogs))
$sql .= ' AND c.id_cart NOT IN ('.join(',', $emailLogs).')';
$emails = Db::getInstance()->executeS($sql);
if ($count OR !sizeof($emails))
return sizeof($emails);
$conf = Configuration::getMultiple(array('PS_FOLLOW_UP_AMOUNT_1', 'PS_FOLLOW_UP_DAYS_1'));
foreach ($emails AS $email)
{
$voucher = $this->createDiscount(1, (float)($conf['PS_FOLLOW_UP_AMOUNT_1']), (int)($email['id_customer']), strftime('%Y-%m-%d', strtotime('+'.(int)($conf['PS_FOLLOW_UP_DAYS_1']).' day')), $this->l('Discount for your cancelled cart'));
if ($voucher !== false)
{
$templateVars = array('{email}' => $email['email'], '{lastname}' => $email['lastname'], '{firstname}' => $email['firstname'], '{amount}' => $conf['PS_FOLLOW_UP_AMOUNT_1'], '{days}' => $conf['PS_FOLLOW_UP_DAYS_1'], '{voucher_num}' => $voucher->code);
$result = Mail::Send((int)$email['id_lang'], 'followup_1', Mail::l('Your cart and your discount', (int)$email['id_lang']), $templateVars, $email['email'], $email['firstname'].' '.$email['lastname'], NULL, NULL, NULL, NULL, dirname(__FILE__).'/mails/');
$this->logEmail(1, (int)($voucher->id), (int)($email['id_customer']), (int)($email['id_cart']));
}
}
}
private function getLogsEmail($emailType)
{
static $idList = array(
'1' => array(),
'2' => array(),
'3' => array(),
'4' => array(),
);
static $executed = false;
if(!$executed)
{
$query = '
SELECT id_cart, id_customer, id_email_type FROM '._DB_PREFIX_.'log_email
WHERE id_email_type <> 4 OR date_add >= DATE_SUB(date_add,INTERVAL '.(int)(Configuration::get('PS_FOLLOW_UP_DAYS_THRESHOLD_4')).' DAY)';
$results = Db::getInstance()->executeS($query);
foreach ($results as $line)
{
switch ($line['id_email_type'])
{
case 1:
$idList['1'][] = $line['id_cart'];
break;
case 2:
$idList['2'][] = $line['id_cart'];
break;
case 3:
$idList['3'][] = $line['id_customer'];
break;
case 4:
$idList['4'][] = $line['id_customer'];
break;
}
}
$executed = true;
}
return $idList[$emailType];
}
/* For all validated orders, a discount if re-ordering before x days */
private function reOrder($count = false)
{
$emailLogs = $this->getLogsEmail(2);
$sql = '
SELECT o.id_order, c.id_cart, o.id_lang, cu.id_customer, cu.firstname, cu.lastname, cu.email
FROM '._DB_PREFIX_.'orders o
LEFT JOIN '._DB_PREFIX_.'customer cu ON (cu.id_customer = o.id_customer)
LEFT JOIN '._DB_PREFIX_.'cart c ON (c.id_cart = o.id_cart)
WHERE o.valid = 1
AND c.date_add >= DATE_SUB(CURDATE(),INTERVAL 7 DAY)
AND cu.is_guest = 0 ';
if(!empty($emailLogs))
$sql .= ' AND o.id_cart NOT IN ('.join(',', $emailLogs).')';
$emails = Db::getInstance()->executeS($sql);
if ($count OR !sizeof($emails))
return sizeof($emails);
$conf = Configuration::getMultiple(array('PS_FOLLOW_UP_AMOUNT_2', 'PS_FOLLOW_UP_DAYS_2'));
foreach ($emails AS $email)
{
$voucher = $this->createDiscount(2, (float)($conf['PS_FOLLOW_UP_AMOUNT_2']), (int)($email['id_customer']), strftime('%Y-%m-%d', strtotime('+'.(int)($conf['PS_FOLLOW_UP_DAYS_2']).' day')), $this->l('Thank you for your order.'));
if ($voucher !== false)
{
$templateVars = array('{email}' => $email['email'], '{lastname}' => $email['lastname'], '{firstname}' => $email['firstname'], '{amount}' => $conf['PS_FOLLOW_UP_AMOUNT_2'], '{days}' => $conf['PS_FOLLOW_UP_DAYS_2'], '{voucher_num}' => $voucher->code);
$result = Mail::Send((int)$email['id_lang'], 'followup_2', Mail::l('Thanks for your order', (int)$email['id_lang']), $templateVars, $email['email'], $email['firstname'].' '.$email['lastname'], NULL, NULL, NULL, NULL, dirname(__FILE__).'/mails/');
$this->logEmail(2, (int)($voucher->id), (int)($email['id_customer']), (int)($email['id_cart']));
}
}
}
/* For all customers with more than x euros in 90 days */
private function bestCustomer($count = false)
{
$emailLogs = $this->getLogsEmail(3);
$sql = '
SELECT SUM(o.total_paid) total, c.id_cart, o.id_lang, cu.id_customer, cu.firstname, cu.lastname, cu.email
FROM '._DB_PREFIX_.'orders o
LEFT JOIN '._DB_PREFIX_.'customer cu ON (cu.id_customer = o.id_customer)
LEFT JOIN '._DB_PREFIX_.'cart c ON (c.id_cart = o.id_cart)
WHERE o.valid = 1
AND DATE_SUB(CURDATE(),INTERVAL 90 DAY) <= o.date_add
AND cu.is_guest = 0 ';
if(!empty($emailLogs))
$sql .= ' AND cu.id_customer NOT IN ('.join(',', $emailLogs).') ';
$sql .= '
GROUP BY o.id_customer
HAVING total >= '.(float)(Configuration::get('PS_FOLLOW_UP_THRESHOLD_3'));
$emails = Db::getInstance()->executeS($sql);
if ($count OR !sizeof($emails))
return sizeof($emails);
$conf = Configuration::getMultiple(array('PS_FOLLOW_UP_AMOUNT_3', 'PS_FOLLOW_UP_DAYS_3'));
foreach ($emails AS $email)
{
$voucher = $this->createDiscount(3, (float)($conf['PS_FOLLOW_UP_AMOUNT_3']), (int)($email['id_customer']), strftime('%Y-%m-%d', strtotime('+'.(int)($conf['PS_FOLLOW_UP_DAYS_3']).' day')), $this->l('You are one of our best customers!'));
if ($voucher !== false)
{
$templateVars = array('{email}' => $email['email'], '{lastname}' => $email['lastname'], '{firstname}' => $email['firstname'], '{amount}' => $conf['PS_FOLLOW_UP_AMOUNT_3'], '{days}' => $conf['PS_FOLLOW_UP_DAYS_3'], '{voucher_num}' => $voucher->code);
$result = Mail::Send((int)$email['id_lang'], 'followup_3', Mail::l('You are one of our best customers', (int)$email['id_lang']), $templateVars, $email['email'], $email['firstname'].' '.$email['lastname'], NULL, NULL, NULL, NULL, dirname(__FILE__).'/mails/');
$this->logEmail(3, (int)($voucher->id), (int)($email['id_customer']), (int)($email['id_cart']));
}
}
}
/* For all customers with no orders since more than x days */
/**
* badCustomer send mails to all customers with no orders since more than x days,
* with at least one valid order in history
*
* @param boolean $count if set to true, will return number of customer (default : false, will send mails, no return value)
* @return void
*/
private function badCustomer($count = false)
{
$emailLogs = $this->getLogsEmail(4);
$sql = '
SELECT o.id_lang, c.id_cart, cu.id_customer, cu.firstname, cu.lastname, cu.email, (SELECT COUNT(o.id_order) FROM '._DB_PREFIX_.'orders o WHERE o.id_customer = cu.id_customer and o.valid = 1) nb_orders
FROM '._DB_PREFIX_.'customer cu
LEFT JOIN '._DB_PREFIX_.'orders o ON (o.id_customer = cu.id_customer)
LEFT JOIN '._DB_PREFIX_.'cart c ON (c.id_cart = o.id_cart)
WHERE cu.id_customer NOT IN (SELECT o.id_customer FROM '._DB_PREFIX_.'orders o WHERE DATE_SUB(CURDATE(),INTERVAL '.(int)(Configuration::get('PS_FOLLOW_UP_DAYS_THRESHOLD_4')).' DAY) <= o.date_add)
AND cu.is_guest = 0 ';
if(!empty($emailLogs))
$sql .= ' AND cu.id_customer NOT IN ('.join(',', $emailLogs).') ';
$sql .= 'GROUP BY cu.id_customer HAVING nb_orders >= 1';
$emails = Db::getInstance()->executeS($sql);
if ($count OR !sizeof($emails))
return sizeof($emails);
$conf = Configuration::getMultiple(array('PS_FOLLOW_UP_AMOUNT_4', 'PS_FOLLOW_UP_DAYS_4'));
foreach ($emails AS $email)
{
$voucher = $this->createDiscount(4, (float)($conf['PS_FOLLOW_UP_AMOUNT_4']), (int)($email['id_customer']), strftime('%Y-%m-%d', strtotime('+'.(int)($conf['PS_FOLLOW_UP_DAYS_4']).' day')), $this->l('We miss you!'));
if ($voucher !== false)
{
$templateVars = array('{email}' => $email['email'], '{lastname}' => $email['lastname'], '{firstname}' => $email['firstname'], '{amount}' => $conf['PS_FOLLOW_UP_AMOUNT_4'], '{days}' => $conf['PS_FOLLOW_UP_DAYS_4'], '{days_threshold}' => (int)(Configuration::get('PS_FOLLOW_UP_DAYS_THRESHOLD_4')), '{voucher_num}' => $voucher->code);
$result = Mail::Send((int)$email['id_lang'], 'followup_4', Mail::l('We miss you', (int)$email['id_lang']), $templateVars, $email['email'], $email['firstname'].' '.$email['lastname'], NULL, NULL, NULL, NULL, dirname(__FILE__).'/mails/');
$this->logEmail(4, (int)($voucher->id), (int)($email['id_customer']), (int)($email['id_cart']));
}
}
}
private function createDiscount($id_email_type, $amount, $id_customer, $dateValidity, $description)
{
$cartRule = new CartRule();
$cartRule->reduction_percent = (float)$amount;
$cartRule->id_customer = (int)$id_customer;
$cartRule->date_to = $dateValidity;
$cartRule->date_from = date('Y-m-d H:i:s');
$cartRule->quantity = 1;
$cartRule->quantity_per_user = 1;
$cartRule->cart_rule_restriction = 1;
$cartRule->minimum_amount = 0;
$languages = Language::getLanguages(true);
foreach ($languages AS $language)
$cartRule->name[(int)$language['id_lang']] = $description;
$code = 'FLW-'.(int)($id_email_type).'-'.strtoupper(Tools::passwdGen(10));
$cartRule->code = $code;
$cartRule->active = 1;
if (!$cartRule->add())
return false;
return $cartRule;
}
public function cronTask()
{
Context::getContext()->link = new Link(); //when this is call by cron context is not init
$conf = Configuration::getMultiple(array('PS_FOLLOW_UP_ENABLE_1', 'PS_FOLLOW_UP_ENABLE_2', 'PS_FOLLOW_UP_ENABLE_3', 'PS_FOLLOW_UP_ENABLE_4', 'PS_FOLLOW_UP_CLEAN_DB'));
if ($conf['PS_FOLLOW_UP_ENABLE_1'])
$this->cancelledCart();
if ($conf['PS_FOLLOW_UP_ENABLE_2'])
$this->reOrder();
if ($conf['PS_FOLLOW_UP_ENABLE_3'])
$this->bestCustomer();
if ($conf['PS_FOLLOW_UP_ENABLE_4'])
$this->badCustomer();
/* Clean-up database by deleting all outdated discounts */
if ($conf['PS_FOLLOW_UP_CLEAN_DB'] == 1)
{
$outdatedDiscounts = Db::getInstance()->executeS('SELECT id_cart_rule FROM '._DB_PREFIX_.'cart_rule WHERE date_to < NOW() AND code LIKE "FLW-%"');
foreach ($outdatedDiscounts AS $outdatedDiscount)
{
$cartRule = new CartRule((int)$outdatedDiscount['id_cart_rule']);
if (Validate::isLoadedObject($cartRule))
$cartRule->delete();
}
}
}
}