Mini Shell
<?php
/**
* 2007-2018 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2007-2018 PrestaShop SA
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
/**
* Class MailCore
*/
class MailCore extends ObjectModel
{
public $id;
/** @var string Recipient */
public $recipient;
/** @var string Template */
public $template;
/** @var string Subject */
public $subject;
/** @var int Language ID */
public $id_lang;
/** @var int Timestamp */
public $date_add;
/**
* @see ObjectModel::$definition
*/
public static $definition = [
'table' => 'mail',
'primary' => 'id_mail',
'fields' => [
'recipient' => [
'type' => self::TYPE_STRING,
'validate' => 'isEmail',
'copy_post' => false,
'required' => true,
'size' => 126
],
'template' => [
'type' => self::TYPE_STRING,
'validate' => 'isTplName',
'copy_post' => false,
'required' => true,
'size' => 62
],
'subject' => [
'type' => self::TYPE_STRING,
'validate' => 'isMailSubject',
'copy_post' => false,
'required' => true,
'size' => 254
],
'id_lang' => [
'type' => self::TYPE_INT,
'validate' => 'isUnsignedId',
'copy_post' => false,
'required' => true
],
'date_add' => [
'type' => self::TYPE_DATE,
'validate' => 'isDate',
'copy_post' => false,
'required' => true
],
],
];
/**
* Mail content type
*/
const TYPE_HTML = 1;
const TYPE_TEXT = 2;
const TYPE_BOTH = 3;
/**
* Send mail under SMTP server
*/
const METHOD_SMTP = 2;
/**
* Disable mail, will return immediately after calling send method
*/
const METHOD_DISABLE = 3;
/**
* Send Email
*
* @param int $idLang Language ID of the email (to translate the template)
* @param string $template Template: the name of template not be a var but a string !
* @param string $subject Subject of the email
* @param string $templateVars Template variables for the email
* @param string $to To email
* @param string $toName To name
* @param string $from From email
* @param string $fromName To email
* @param array $fileAttachment Array with three parameters (content, mime and name).
* You can use an array of array to attach multiple files
* @param bool $mode_smtp SMTP mode (deprecated)
* @param string $templatePath Template path
* @param bool $die Die after error
* @param int $idShop Shop ID
* @param string $bcc Bcc recipient address. You can use an array of array to send to multiple recipients
* @param string $replyTo Reply-To recipient address
* @param string $replyToName Reply-To recipient name
*
* @return bool|int Whether sending was successful. If not at all, false, otherwise amount of recipients succeeded.
*/
public static function send(
$idLang,
$template,
$subject,
$templateVars,
$to,
$toName = null,
$from = null,
$fromName = null,
$fileAttachment = null,
$mode_smtp = null,
$templatePath = _PS_MAIL_DIR_,
$die = false,
$idShop = null,
$bcc = null,
$replyTo = null,
$replyToName = null
) {
if (!$idShop) {
$idShop = Context::getContext()->shop->id;
}
$keepGoing = array_reduce(
Hook::exec(
'actionEmailSendBefore',
[
'idLang' => &$idLang,
'template' => &$template,
'subject' => &$subject,
'templateVars' => &$templateVars,
'to' => &$to,
'toName' => &$toName,
'from' => &$from,
'fromName' => &$fromName,
'fileAttachment' => &$fileAttachment,
'mode_smtp' => &$mode_smtp,
'templatePath' => &$templatePath,
'die' => &$die,
'idShop' => &$idShop,
'bcc' => &$bcc,
'replyTo' => &$replyTo
],
null,
true
),
function ($carry, $item) {
return ($item === false) ? false : $carry;
},
true
);
if (!$keepGoing) {
return true;
}
if (is_numeric($idShop) && $idShop) {
$shop = new Shop((int) $idShop);
}
$configuration = Configuration::getMultiple(
[
'PS_SHOP_EMAIL',
'PS_MAIL_METHOD',
'PS_MAIL_SERVER',
'PS_MAIL_USER',
'PS_MAIL_PASSWD',
'PS_SHOP_NAME',
'PS_MAIL_SMTP_ENCRYPTION',
'PS_MAIL_SMTP_PORT',
'PS_MAIL_TYPE'
],
null,
null,
$idShop
);
// Returns immediately if emails are deactivated
if ($configuration['PS_MAIL_METHOD'] == self::METHOD_DISABLE) {
return true;
}
// Hook to alter template vars
Hook::exec(
'sendMailAlterTemplateVars',
[
'template' => $template,
'template_vars' => &$templateVars,
]
);
if (!isset($configuration['PS_MAIL_SMTP_ENCRYPTION']) ||
Tools::strtolower($configuration['PS_MAIL_SMTP_ENCRYPTION']) === 'off'
) {
$configuration['PS_MAIL_SMTP_ENCRYPTION'] = false;
}
if (!isset($configuration['PS_MAIL_SMTP_PORT'])) {
$configuration['PS_MAIL_SMTP_PORT'] = 'default';
}
/**
* Sending an e-mail can be of vital importance for the merchant, when his password
* is lost for example, so we must not die but do our best to send the e-mail.
*/
if (!isset($from) || !Validate::isEmail($from)) {
$from = $configuration['PS_SHOP_EMAIL'];
}
if (!Validate::isEmail($from)) {
$from = null;
}
// $from_name is not that important, no need to die if it is not valid
if (!isset($fromName) || !Validate::isMailName($fromName)) {
$fromName = $configuration['PS_SHOP_NAME'];
}
if (!Validate::isMailName($fromName)) {
$fromName = null;
}
/**
* It would be difficult to send an e-mail if the e-mail is not valid,
* so this time we can die if there is a problem.
*/
if (!is_array($to) && !Validate::isEmail($to)) {
self::dieOrLog($die, 'Error: parameter "to" is corrupted');
return false;
}
// if bcc is not null, make sure it's a vaild e-mail
if (!is_null($bcc) && !is_array($bcc) && !Validate::isEmail($bcc)) {
self::dieOrLog($die, 'Error: parameter "bcc" is corrupted');
$bcc = null;
}
if (!is_array($templateVars)) {
$templateVars = [];
}
// Do not crash for this error, that may be a complicated customer name
if (is_string($toName) && !empty($toName) && !Validate::isMailName($toName)) {
$toName = null;
}
if (!Validate::isTplName($template)) {
self::dieOrLog($die, 'Error: invalid e-mail template');
return false;
}
if (!Validate::isMailSubject($subject)) {
self::dieOrLog($die, 'Error: invalid e-mail subject');
return false;
}
/* Construct multiple recipients list if needed */
$message = \Swift_Message::newInstance();
if (is_array($to) && isset($to)) {
foreach ($to as $key => $addr) {
$addr = trim($addr);
if (!Validate::isEmail($addr)) {
self::dieOrLog($die, 'Error: invalid e-mail address');
return false;
}
if (is_array($toName) && isset($toName[$key])) {
$addrName = $toName[$key];
} else {
$addrName = $toName;
}
$addrName = ($addrName == null || $addrName == $addr || !Validate::isGenericName($addrName)) ?
'' :
self::mimeEncode($addrName);
$message->addTo(self::toPunycode($addr), $addrName);
}
$toPlugin = $to[0];
} else {
/* Simple recipient, one address */
$toPlugin = $to;
$toName = (($toName == null || $toName == $to) ? '' : self::mimeEncode($toName));
$message->addTo(self::toPunycode($to), $toName);
}
if (isset($bcc) && is_array($bcc)) {
foreach ($bcc as $addr) {
$addr = trim($addr);
if (!Validate::isEmail($addr)) {
self::dieOrLog($die, 'Error: invalid e-mail address');
return false;
}
$message->addBcc(self::toPunycode($addr));
}
} elseif (isset($bcc)) {
$message->addBcc(self::toPunycode($bcc));
}
try {
/* Connect with the appropriate configuration */
if ($configuration['PS_MAIL_METHOD'] == self::METHOD_SMTP) {
if (empty($configuration['PS_MAIL_SERVER']) || empty($configuration['PS_MAIL_SMTP_PORT'])) {
self::dieOrLog($die, 'Error: invalid SMTP server or SMTP port');
return false;
}
$connection = \Swift_SmtpTransport::newInstance(
$configuration['PS_MAIL_SERVER'],
$configuration['PS_MAIL_SMTP_PORT'],
$configuration['PS_MAIL_SMTP_ENCRYPTION']
)
->setUsername($configuration['PS_MAIL_USER'])
->setPassword($configuration['PS_MAIL_PASSWD']);
} else {
$connection = \Swift_MailTransport::newInstance();
}
if (!$connection) {
return false;
}
$swift = \Swift_Mailer::newInstance($connection);
/* Get templates content */
$iso = Language::getIsoById((int) $idLang);
$isoDefault = Language::getIsoById((int) Configuration::get('PS_LANG_DEFAULT'));
$isoArray = [];
if ($iso) {
$isoArray[] = $iso;
}
if ($isoDefault && $iso !== $isoDefault) {
$isoArray[] = $isoDefault;
}
if (!in_array('en', $isoArray)) {
$isoArray[] = 'en';
}
$moduleName = false;
// get templatePath
if (preg_match('#'.$shop->physical_uri.'modules/#', str_replace(DIRECTORY_SEPARATOR, '/', $templatePath)) &&
preg_match('#modules/([a-z0-9_-]+)/#ui', str_replace(DIRECTORY_SEPARATOR, '/', $templatePath), $res)
) {
$moduleName = $res[1];
}
foreach ($isoArray as $isoCode) {
$isoTemplate = $isoCode.'/'.$template;
$templatePath = self::getTemplateBasePath($isoTemplate, $moduleName, $shop->theme);
if (!file_exists($templatePath.$isoTemplate.'.txt') &&
(
$configuration['PS_MAIL_TYPE'] == Mail::TYPE_BOTH ||
$configuration['PS_MAIL_TYPE'] == Mail::TYPE_TEXT
)
) {
PrestaShopLogger::addLog(
Context::getContext()->getTranslator()->trans(
'Error - The following e-mail template is missing: %s',
[$templatePath.$isoTemplate.'.txt'],
'Admin.Advparameters.Notification'
)
);
} elseif (!file_exists($templatePath.$isoTemplate.'.html') &&
(
$configuration['PS_MAIL_TYPE'] == Mail::TYPE_BOTH ||
$configuration['PS_MAIL_TYPE'] == Mail::TYPE_HTML
)
) {
PrestaShopLogger::addLog(
Context::getContext()->getTranslator()->trans(
'Error - The following e-mail template is missing: %s',
[$templatePath.$isoTemplate.'.html'],
'Admin.Advparameters.Notification'
)
);
} else {
$templatePathExists = true;
break;
}
}
if (empty($templatePathExists)) {
self::dieOrLog($die, 'Error - The following e-mail template is missing: %s', [$template]);
return false;
}
$templateHtml = '';
$templateTxt = '';
Hook::exec(
'actionEmailAddBeforeContent',
[
'template' => $template,
'template_html' => &$templateHtml,
'template_txt' => &$templateTxt,
'id_lang' => (int) $idLang,
],
null,
true
);
$templateHtml .= Tools::file_get_contents($templatePath.$isoTemplate.'.html');
$templateTxt .= strip_tags(
html_entity_decode(
Tools::file_get_contents($templatePath.$isoTemplate.'.txt'),
null,
'utf-8'
)
);
Hook::exec(
'actionEmailAddAfterContent',
[
'template' => $template,
'template_html' => &$templateHtml,
'template_txt' => &$templateTxt,
'id_lang' => (int) $idLang,
],
null,
true
);
/* Create mail and attach differents parts */
$subject = '['.Configuration::get('PS_SHOP_NAME', null, null, $idShop).'] '.$subject;
$message->setSubject($subject);
$message->setCharset('utf-8');
/* Set Message-ID - getmypid() is blocked on some hosting */
$message->setId(Mail::generateId());
if (!($replyTo && Validate::isEmail($replyTo))) {
$replyTo = $from;
}
if (isset($replyTo) && $replyTo) {
$message->setReplyTo($replyTo, ($replyToName !== '' ? $replyToName : null));
}
$templateVars = array_map(['Tools', 'htmlentitiesDecodeUTF8'], $templateVars);
$templateVars = array_map(['Tools', 'stripslashes'], $templateVars);
if (false !== Configuration::get('PS_LOGO_MAIL') &&
file_exists(_PS_IMG_DIR_.Configuration::get('PS_LOGO_MAIL', null, null, $idShop))
) {
$logo = _PS_IMG_DIR_.Configuration::get('PS_LOGO_MAIL', null, null, $idShop);
} else {
if (file_exists(_PS_IMG_DIR_.Configuration::get('PS_LOGO', null, null, $idShop))) {
$logo = _PS_IMG_DIR_.Configuration::get('PS_LOGO', null, null, $idShop);
} else {
$templateVars['{shop_logo}'] = '';
}
}
ShopUrl::cacheMainDomainForShop((int) $idShop);
/* don't attach the logo as */
if (isset($logo)) {
$templateVars['{shop_logo}'] = $message->embed(\Swift_Image::fromPath($logo));
}
if ((Context::getContext()->link instanceof Link) === false) {
Context::getContext()->link = new Link();
}
$templateVars['{shop_name}'] = Tools::safeOutput(Configuration::get('PS_SHOP_NAME', null, null, $idShop));
$templateVars['{shop_url}'] = Context::getContext()->link->getPageLink(
'index',
true,
$idLang,
null,
false,
$idShop
);
$templateVars['{my_account_url}'] = Context::getContext()->link->getPageLink(
'my-account',
true,
$idLang,
null,
false,
$idShop
);
$templateVars['{guest_tracking_url}'] = Context::getContext()->link->getPageLink(
'guest-tracking',
true,
$idLang,
null,
false,
$idShop
);
$templateVars['{history_url}'] = Context::getContext()->link->getPageLink(
'history',
true,
$idLang,
null,
false,
$idShop
);
$templateVars['{color}'] = Tools::safeOutput(Configuration::get('PS_MAIL_COLOR', null, null, $idShop));
// Get extra template_vars
$extraTemplateVars = [];
Hook::exec(
'actionGetExtraMailTemplateVars',
[
'template' => $template,
'template_vars' => $templateVars,
'extra_template_vars' => &$extraTemplateVars,
'id_lang' => (int) $idLang,
],
null,
true
);
$templateVars = array_merge($templateVars, $extraTemplateVars);
$swift->registerPlugin(new \Swift_Plugins_DecoratorPlugin(array($toPlugin => $templateVars)));
if ($configuration['PS_MAIL_TYPE'] == Mail::TYPE_BOTH ||
$configuration['PS_MAIL_TYPE'] == Mail::TYPE_TEXT
) {
$message->addPart($templateTxt, 'text/plain', 'utf-8');
}
if ($configuration['PS_MAIL_TYPE'] == Mail::TYPE_BOTH ||
$configuration['PS_MAIL_TYPE'] == Mail::TYPE_HTML
) {
$message->addPart($templateHtml, 'text/html', 'utf-8');
}
if ($fileAttachment && !empty($fileAttachment)) {
// Multiple attachments?
if (!is_array(current($fileAttachment))) {
$fileAttachment = array($fileAttachment);
}
foreach ($fileAttachment as $attachment) {
if (isset($attachment['content']) && isset($attachment['name']) && isset($attachment['mime'])) {
$message->attach(
\Swift_Attachment::newInstance()->setFilename(
$attachment['name']
)->setContentType($attachment['mime'])
->setBody($attachment['content'])
);
}
}
}
/* Send mail */
$message->setFrom(array($from => $fromName));
$send = $swift->send($message);
ShopUrl::resetMainDomainCache();
if ($send && Configuration::get('PS_LOG_EMAILS')) {
$mail = new Mail();
$mail->template = Tools::substr($template, 0, 62);
$mail->subject = Tools::substr($subject, 0, 254);
$mail->id_lang = (int) $idLang;
$recipientsTo = $message->getTo();
$recipientsCc = $message->getCc();
$recipientsBcc = $message->getBcc();
if (!is_array($recipientsTo)) {
$recipientsTo = [];
}
if (!is_array($recipientsCc)) {
$recipientsCc = [];
}
if (!is_array($recipientsBcc)) {
$recipientsBcc = [];
}
foreach (array_merge($recipientsTo, $recipientsCc, $recipientsBcc) as $email => $recipient_name) {
/** @var Swift_Address $recipient */
$mail->id = null;
$mail->recipient = Tools::substr($email, 0, 126);
$mail->add();
}
}
return $send;
} catch (\Swift_SwiftException $e) {
PrestaShopLogger::addLog(
'Swift Error: '.$e->getMessage(),
3,
null,
'Swift_Message'
);
return false;
}
}
protected static function getTemplateBasePath($isoTemplate, $moduleName, $theme)
{
$basePathList = [
_PS_ROOT_DIR_.'/themes/'.$theme->getName().'/',
_PS_ROOT_DIR_.'/themes/'.$theme->get('parent').'/',
_PS_ROOT_DIR_,
];
if ($moduleName !== false) {
$templateRelativePath = '/modules/'.$moduleName.'/mails/';
} else {
$templateRelativePath = '/mails/';
}
foreach ($basePathList as $base) {
$templatePath = $base.$templateRelativePath;
if (file_exists($templatePath.$isoTemplate.'.txt') || file_exists($templatePath.$isoTemplate.'.html')) {
return $templatePath;
}
}
return '';
}
/**
* @param $idMail Mail ID
*
* @return bool Whether removal succeeded
*/
public static function eraseLog($idMail)
{
return Db::getInstance()->delete('mail', 'id_mail = '.(int) $idMail);
}
/**
* @return bool
*/
public static function eraseAllLogs()
{
return Db::getInstance()->execute('TRUNCATE TABLE '._DB_PREFIX_.'mail');
}
/**
* Send a test email.
*
* @param bool $smtpChecked Is SMTP checked?
* @param string $smtp_server SMTP Server hostname
* @param string $content Content of the email
* @param string $subject Subject of the email
* @param bool $type Deprecated
* @param string $to To email address
* @param string $from From email address
* @param string $smtpLogin SMTP login name
* @param string $smtpPassword SMTP password
* @param int $smtpPort SMTP Port
* @param bool|string $smtpEncryption Encryption type. "off" or false disable encryption.
*
* @return bool|string True if succeeded, otherwise the error message
*/
public static function sendMailTest(
$smtpChecked,
$smtp_server,
$content,
$subject,
$type,
$to,
$from,
$smtpLogin,
$smtpPassword,
$smtpPort,
$smtpEncryption
) {
$result = false;
try {
if ($smtpChecked) {
if (Tools::strtolower($smtpEncryption) === 'off') {
$smtpEncryption = false;
}
$smtp = \Swift_SmtpTransport::newInstance($smtp_server, $smtpPort, $smtpEncryption)
->setUsername($smtpLogin)
->setPassword($smtpPassword);
$swift = \Swift_Mailer::newInstance($smtp);
} else {
$swift = \Swift_Mailer::newInstance(\Swift_MailTransport::newInstance());
}
$message = \Swift_Message::newInstance();
$message
->setFrom($from)
->setTo($to)
->setSubject($subject)
->setBody($content);
if ($swift->send($message)) {
$result = true;
}
} catch (\Swift_SwiftException $e) {
$result = $e->getMessage();
}
return $result;
}
/**
* This method is used to get the translation for email Object.
* For an object is forbidden to use htmlentities,
* we have to return a sentence with accents.
*
* @param string $string raw sentence (write directly in file)
*
* @return mixed
*/
public static function l($string, $idLang = null, Context $context = null)
{
global $_LANGMAIL;
if (!$context) {
$context = Context::getContext();
}
if ($idLang === null) {
$idLang = (!isset($context->language) || !is_object($context->language)) ?
(int)Configuration::get('PS_LANG_DEFAULT') :
(int)$context->language->id;
}
$isoCode = Language::getIsoById((int) $idLang);
$file_core = _PS_ROOT_DIR_.'/mails/'.$isoCode.'/lang.php';
if (Tools::file_exists_cache($file_core) && empty($_LANGMAIL)) {
include $file_core;
}
$fileTheme = _PS_THEME_DIR_.'mails/'.$isoCode.'/lang.php';
if (Tools::file_exists_cache($fileTheme)) {
include $fileTheme;
}
if (!is_array($_LANGMAIL)) {
return str_replace('"', '"', $string);
}
$key = str_replace('\'', '\\\'', $string);
return str_replace(
'"',
'"',
Tools::stripslashes(
(array_key_exists($key, $_LANGMAIL) && !empty($_LANGMAIL[$key])) ? $_LANGMAIL[$key] : $string
)
);
}
/* Rewrite of Swift_Message::generateId() without getmypid() */
protected static function generateId($idstring = null)
{
$midparams = [
'utctime' => gmstrftime('%Y%m%d%H%M%S'),
'randint' => mt_rand(),
'customstr' => (preg_match('/^(?<!\\.)[a-z0-9\\.]+(?!\\.)$/iD', $idstring) ? $idstring : 'swift'),
'hostname' => !empty($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : php_uname('n'),
];
return vsprintf('%s.%d.%s@%s', $midparams);
}
/**
* Check if a multibyte character set is used for the data.
*
* @param string $data Data
*
* @return bool Whether the string uses a multibyte character set
*/
public static function isMultibyte($data)
{
$length = Tools::strlen($data);
for ($i = 0; $i < $length; $i++) {
if (ord(($data[$i])) > 128) {
return true;
}
}
return false;
}
/**
* MIME encode the string.
*
* @param string $string The string to encode
* @param string $charset The character set to use
* @param string $newline The newline character(s)
*
* @return mixed|string MIME encoded string
*/
public static function mimeEncode($string, $charset = 'UTF-8', $newline = "\r\n")
{
if (!self::isMultibyte($string) && Tools::strlen($string) < 75) {
return $string;
}
$charset = Tools::strtoupper($charset);
$start = '=?'.$charset.'?B?';
$end = '?=';
$sep = $end.$newline.' '.$start;
$length = 75 - Tools::strlen($start) - Tools::strlen($end);
$length = $length - ($length % 4);
if ($charset === 'UTF-8') {
$parts = [];
$maxchars = floor(($length * 3) / 4);
$stringLength = Tools::strlen($string);
while ($stringLength > $maxchars) {
$i = (int) $maxchars;
$result = ord($string[$i]);
while ($result >= 128 && $result <= 191) {
$result = ord($string[--$i]);
}
$parts[] = base64_encode(Tools::substr($string, 0, $i));
$string = Tools::substr($string, $i);
$stringLength = Tools::strlen($string);
}
$parts[] = base64_encode($string);
$string = implode($sep, $parts);
} else {
$string = chunk_split(base64_encode($string), $length, $sep);
$string = preg_replace('/'.preg_quote($sep).'$/', '', $string);
}
return $start.$string.$end;
}
/**
* Automatically convert email to Punycode.
*
* @param string $to Email address
*
* @return string
*/
public static function toPunycode($to)
{
$address = explode('@', $to);
if (empty($address[0]) || empty($address[1])) {
return $to;
}
return $address[0].'@'.idn_to_ascii($address[1]);
}
/**
* Generic function to dieOrLog with translations.
*
* @param boolean $die Should die
* @param string $message Message
* @param array $templates Templates list
* @param string $domain Translation domain
*/
protected static function dieOrLog(
$die,
$message,
$templates = [],
$domain = 'Admin.Advparameters.Notification'
) {
Tools::dieOrLog(
Context::getContext()->getTranslator()->trans(
$message,
$templates,
$domain
),
$die
);
}
}
Zerion Mini Shell 1.0