LSmail: add possibility to send email using template

This commit is contained in:
Benjamin Renard 2024-02-19 19:59:55 +01:00
parent e9c49c242f
commit 87e58e6425
Signed by: bn8
GPG key ID: 3E2E1CE1907115BC
3 changed files with 305 additions and 1 deletions

View file

@ -0,0 +1,7 @@
{literal}<div id='logo'><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAAAuCAMAAABam6YzAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAAlwSFlzAAAZ5QAAGeUBblTa3gAAAwBQTFRFR3BMAAAAAAAAAAAAAHK4AAAAAAAAAHK5AHO5AHK4AHK4AAAAAHS3AHC3AHG5AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/AAAAAAAAAAAAAAAAAAAAAAAAAHG4AAAAAHq6AHW3AAAAAG+4AAAAAAAAAHK4AAAAAAAAAAAAAHK4AAAAAG/BAAAAAHK4AAAAAAAAAHK4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK4AAAAAAAAAAAAAHK4AHK5AAAAAHK4AHK3AHK4AAAAAHK4AAAAAICAAHK3AAAAAAAAAAAAAAAAAHK4AHK4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHS5AHS5AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK4AAAAAAAAAAAAAAAAAHG4AHO5AAAAAHG4AAAAAAAAAHK5AHK4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK4AAAAAAAAAG+1AAAAAAAAAAAAAAAAAAAAAAAAAAAAAHK4AHK4AAAAAHO4AAAAAAAAAAAAAAAAAHO4AAAAAHK4AHK5AHG4AHK5AAAAAAAAAHK4AAAAAHG5AHO4AAAAAAAAAAAAAAAAAHK4AAAAAHG4AAAAAHK4AAAAAAAAAHG4AAAAAHK4AHK5AAAAAAAAAAAAAHW6AAAAAHG4AFWqAAAAAHG4AAAAAAAAAHG4AAAAAHK4AHK3AAAAAHK5AHG5AAAAAAAAAAAAAGazAHO4AHG5AAAAAAAAAHK3AHG2AAAAAHK3AAAAAAAAAHK4AHK4AHK4AHK2AHK4AHG4AHK5AHK3AHO5AHK4AHG4AHK5AHK4AHK4AHK4AHO4AHK4AHO5AHG4AHK3AHO5AHS3AHK4AAAAAHK6AHO3AHK4AAAAAHO4AHC6AHG5AHK4AHK4AHK5AHG4AHO3AHK3AHK4AHK5AHG4AHK4AHK4AAAAAHK4AAAAAHK4ip4/vAAAAP50Uk5TAPoK/GvACHuVhP7+QCBNAgkGYeBKK/QBAcoF6Cb9zXTdCBtlE0kR6exeA/x1BQTvm0/5okPx2+lyetwyeA7uthzXuSM3FVv4xPBF9mXAbHgsuB5J2AIeavPyxVxxii4h5NO055gWC9k0lqiLsoahlMy/gWMPYiLV2gyn5fVYk+ovhJF+8FUXDZpoIL2t1DrFPYeCuhZ9rm8Q6KJakFMZlqR+sjw5E1Cd0Fc+rCjC0W/JbEG8RxDIOQPBT6vHh6/hi0z3KfW7sAp2X3DipCVNYOGejcLeOO0Y0oBLtKs1VOLX0NOovctBLp+ORVL0fMYwMqWvmOOgktbHaL6TKppMfRALAAAJvUlEQVRo3u1Zd1gU1xafXQSVjSKdpcOCDxARLBTpKPiQDhYEG4giIigWihUVjSUxlqjB3lCMXTFGsbdEjQWJLZrY8vJSzEt7vZz7zpSd3ZnZ4YOgJvm+nH/2zjm3/e6p9y5F/U6/derp4DD+ZwwbfTvje/euTfe5UV19UkaUUl09tKVLllha7m9CHAIwoaVTft34nNBkOvFMxhj5bm0IaScjak9I2xYuqnQC2NGE/A0Ai5bNWNpI9CjxVQHZDgDpTcgtAUJbNOEH93D7d768/68ta9/q3iSQxKqqMzKitlVVLi0EMhjAqwlxZwCFfYsm/BJNysWN8xSXx4mvypn9AS425esAzi2arytqYYXe95hXBcQZYJghfsWIcPrHF8BfjztlsYmBvraxG/n2n9GwSmXWOlLqMVD+BAa5u8nJBnqUjn6/aRz2CoCZEm74qgHoOvkaW2oawCKOt6EhMAG5Qbl9+X7FMTFRVN2pfgARh4ezrGxCuhtYxy1jU/k5xPj883X8jj5JS2vDNT/dPd0Upef+eT+V+b6clraLH/vZgxkoq3r4aVNAKnFrjmJmXRCwNM0nEIDdd5QCeJqr1ZoTKN7ZzDH7eTO8DFxzkHSd3ro41ughiVo7ddKPxFHL/S+87JadPBALgEwzEW8+7tnrjf2+kQAhKjDqxDADAKLrC69M2myDm57PdlwKUBYDiqxJYfUqgAuMfXXABXdK13lEuqX9lPLhpn00kvdFQFKQ+daKg21Orj0tAVI6HYNH2vqh7Z5gp/XyQOYCZIlY/8WtTvOjWxrAJJPDcicXWXNushJAzTaTaU28GcUoEc1rFt2wm0jvquProkl/yGYdwG4dGthUIZCBz0mXz1iW3RfZQiBdcbqnRxnRGgwjn8gCyeLW15F5NEAepyTUCRSLh7xjBJm2TKsBxSc68ydiyTRSu9NW0OXA+mwPgytOJWSiEMg1VJJcQkzEnHSXY27BE5LDYZYpSdyL0Ia0xrYBd3pFMgiRxjKNWnT9KRxzOIARm3C+KOdMukvj0A8MrNmNmB4RAHmNkANyQJ7y+sOAgVbmLgPEEXdaKVTIVQBvSrc7eFcyaDaAkumq4EMaljq6qOH24Z9MOSy9l0nXTCLktgDIXSKxGS0QdxTpFPsjIbtkgMyUJO7raCJ+2o8RAKoKbYiKm2BcNtIBCcCB4YQC2FTwA9FJ+vAf7ok79zFgTDtqWYNWfPTv8mokNL2vhc6Occn0wVR3A0B2EXK6A0+bCEmRATJMkrgXAhTp4jBAIAdj+QVd+IUlFBsLoJ7vmg6cnni6e4OOuX9l3d79hy56lWRHIZDUO6z6/pPhJgKyhojolgyQi8LEjeQKEMd/BAOMY7NIGe6zV2RDYUhY2DGAQoZZABDMd/UEiJdkwd24NFP8udGxbPrDn9qnpKT8QwKEGr32HLvP6nVCIFvEQP4uA8QLYLCw2lDoV7tYiPnSv35YyESfNWeZS7S1wAkAT74r1jKnpDUJHvXf6EY7hLGMS2eNUiBYMx/f9JjZ6QoBkKEYB17Tp2uGcUThOW8XcGKRw9t9eDxATy5tRr/NMd824rzaJ0Efc62e4+sojQtIjwjhC4xqQ0AY8zt4GkNdqj6Qdaik5lSMmK6dhIa9AIEs1n6E4UcN3YjhNMPV/UOYNGKN0kN6lmUTK10AbesJrRlCuvFaInJAKOp19Kqh+kCuGS54JDQJT1rEwrTen2t2CtImOVfdlqPQGvcyrTgEMlk7DB1nuYEFPibkAVsS9+av400AoW4RskmQR1BHZ5oBZDzAZhErR+vflHkuaO0+n88tfsf4ovErPnwxJxLE6I46elmv3r5M2BMeY0pMuXTg0U0CRK8UXMsFBx7IQTS273RyuapxJECYiY7ohD4HrW0Dk+EO04F2FdOvHjXHeM5wZ5rJgiqhmxqmPsD4ZcSp7BvSu20H7k5FV0dVo7nidzfzppL6WBp+1/yYwV1Tbj8nZJkAiBvWin+4we2/9GSjYRw1ICS6YA9H04Fxycmn4iFHDWDFdLRC3qiiyZPGK2A1mhlTPtpiJEAA44M1m0ehWPsS8w290Y+f3drSbit99qZsKt5Fp4n72S7PZpAnn4uBuBDy6NnJxHUuWzHXPLQTVr8dsC4h+/7nMnXF2gOmpFzgzwVBsyOZa1B/IQ4FU7AHZHKfJQsQE3f1y+N4qgk1Kkjw4bK+pVLN8RN4Zzk6XT/sVx+nRDeOe4O2GgDCU5qb+D5yV/9RZqIejhGjMH6qem2jLx7GAuLqXMclmMRVWd62NcbG/NucN1ohXBi3lLI2Nl6oLShXU8phEcj3Wqj/DvNd2z/eYcqTGY0Hj/Dcjvfo1F6+xY1qn5TE1OXU8aSkNUysOr7+KZP372zVlmZTk5Ky+aEZjG5J9/L1y/RvyrlOzBnOtpWPAWaOjhXS95TKdEFVVsQ6kF96aLqPgQv496mDRPfzrufPe8guaeeRel7+nWKge2qqeKx5P9YY4pe28tUC7ypnf8m33JohLJCInq2cCJNM1C8JxNaLBTJkcevm2YjW2fJRfjV9xvafrwlbnjcuRl1bm5NTFh09ID8/MNDV0tU5ZtqESfu9rfo61pgZHCx6iQphVKJa2coDOQvQ7CmUjoe8w2atVl/NhOaRU0T+pTkzrUVPnMV7RDeOIUYqBexVtg7IKpmHPX13dLRaNKdhZVk8v794V+cl9f6FIYNnevZ1XDAlvKJC2cnE3Nzez8eM8ondszTAwne5/+q9ZQ7s25PizXGrdjjy6tkcf0h0vw3+tk4NxypaBWTOe+95yslMrAOC8y5aOnH7t8kv6bE8ecfYjWbNn77zds3cww5sjnIuDmbSXg9QSP8YmHIC1H1euAMqKzeE+ZeMVLHJc6Sx/7cW/a2ntCIyHUrOy2IUerPA0yQaf+dIskZFCdhoXhiC8ND5IQ17R3EWdPNwnu8O604vavKounlqPJsE9vHTXCz2CVHAyrGtXSS2b9y8HidmswiMXGMKgq/vMX8JwXaBxWruzTarRiIMRV3l/kwoPot7aobV13JJSREYOTfZ09GeeokUasS5XK890rCisQTIKezZkiNUoiMXxARyx2OTc+mrwf1H+Lz8/Lc9gg/OEe8aSFAWtfR2xg8e0SwjKs7i3ABGZRXPi1u64NUl8m11nlZIZ6/HJQd4GqwTozT1dFwIvFQQYlFn3Vl4/IvHWln4FhZHqm/acH8eDIicdSXAWkn9KslvW5GzSvs3h2u+q+XVkQ5eEb1s9P4SgQj1tCKLQ1Fm1K+dOldaaeYtzHUO4hAZKRIy4y3VuQ3DfL2txqYrqd8c2YcrTezNqN/p1dD/ATUlLV+5hbDAAAAAAElFTkSuQmCC" alt="LdapSaisie"/></div>{/literal}
<h2>Welcome {$name}!</h2>
<p>This email is just an example of an email template.</p>
<p>Regards,</p>

View file

@ -0,0 +1 @@
Welcome {$name}!

View file

@ -20,7 +20,20 @@
******************************************************************************/
class LSmail {
class LSmail extends LSlog_staticLoggerClass {
/**
* Array of templates directories where file have to be search
* @var array
*/
private static $template_directories = array('local', './');
/**
* Cache of loaded templates
* @see list_templates()
* @var array<string,array<string,string|null>>
*/
private static $_templates = null;
/*
* Méthode chargeant les dépendances d'affichage
@ -81,4 +94,287 @@ class LSmail {
}
}
/**
* List exiting email templates
* @return array<string,array<string,string|null>>
* [
* '[name]' => [
* 'subject' => '/path/to/name.subject' or null,
* 'html' => '/path/to/name.html' or null,
* 'txt' => '/path/to/name.txt' or null,
* ],
* [...]
* ]
*/
public static function list_templates() {
if (self :: $_templates)
return self :: $_templates;
self :: $_templates = [];
$expected_extensions = ['subject', 'html', 'txt'];
foreach(self :: $template_directories as $dir) {
$dir_path = realpath(LS_ROOT_DIR."/".$dir."/email_templates");
if ($dir_path === false)
// Directory not found or not accessible
continue;
foreach (new DirectoryIterator($dir_path) as $fileInfo) {
if(
$fileInfo->isDot()
|| !$fileInfo->isFile()
|| !$fileInfo->isReadable()
|| !in_array($fileInfo->getExtension(), $expected_extensions)
)
continue;
$name = $fileInfo->getBasename(".".$fileInfo->getExtension());
if (!array_key_exists($name, self :: $_templates)) {
self :: $_templates[$name] = [];
foreach($expected_extensions as $ext) self :: $_templates[$name][$ext] = null;
}
if (!self :: $_templates[$name][$fileInfo->getExtension()])
self :: $_templates[$name][$fileInfo->getExtension()] = $fileInfo->getRealPath();
}
}
return self :: $_templates;
}
/**
* Send email from template
* @param string $tplname The email template name
* @param string $to The email recipient
* @param array<string,mixed> $variables Variables to use to compute the template
* @param array<string,string>|null $headers Email headers
* @param array<string,string>|null $attachments Email attachments as an array with
* filepath as key and filename as value
* @return boolean True if the email was sent, false otherwise
*/
public static function send_mail_from_template(
$tplname, $to, $variables=null, $headers=null, $attachments=null
) {
$templates = self :: list_templates();
if (!array_key_exists($tplname, $templates)) {
LSerror :: addErrorCode('LSmail_01', $tplname);
return False;
}
$tpl = $templates[$tplname];
if (!$tpl['subject'] || !($tpl['txt'] || $tpl['html'])) {
LSerror :: addErrorCode('LSmail_02', $tplname);
return False;
}
$smarty = new Smarty();
if (is_array($variables))
array_map([$smarty, "assign"], array_keys($variables), array_values($variables));
try {
$subject = $smarty -> fetch("file:{$tpl['subject']}");
// Multiple line from subject cause problem, trim it and only the first line
$subject = explode("\n", trim($subject))[0];
self :: log_debug(
"send_mail_from_template($tplname, ".implode("|", $to)."): ".
"subject compute from '{$tpl['subject']}'."
);
if ($tpl['html']) {
$body = $smarty -> fetch("file:{$tpl['html']}");
$html = true;
self :: log_debug(
"send_mail_from_template($tplname, ".implode("|", $to)."): ".
"HTML body compute from '{$tpl['html']}'."
);
}
else {
$body = $smarty -> fetch("file:{$tpl['txt']}");
$html = false;
self :: log_debug(
"send_mail_from_template($tplname, ".implode("|", $to)."): ".
"text body compute from '{$tpl['txt']}'."
);
}
}
catch (Exception $e) {
self :: log_exception(
$e, getFData(
_("LSmail - An exception occured forging message from email template '%{template}'"),
$tplname
),
false
);
return false;
}
return sendMail($to, $subject, $body, $headers, $attachments, "\n", "utf8", $html);
}
/**
* CLI test_send_mail_template command
*
* @param array $command_args Command arguments :
* - Positional arguments :
* - template name
* - recipient
* - Optional arguments :
* - -V|--variable: template variable (format: variable=value)
* - -H|--header: header (format: header=value)
* - -a|--attachent: (format: /path/to/file.ext:filename or just /path/to/file.ext)
* - -bcc: BCC recipient(s)
* - -cc: CC recipient(s)
*
* @return boolean True on success, false otherwise
**/
public static function cli_test_send_mail_template($command_args) {
$template = null;
$recipients = array();
$variables = array();
$headers = array();
$attachments = array();
for ($i=0; $i < count($command_args); $i++) {
LScli :: unquote_word($command_args[$i]);
if (in_array($command_args[$i], array('-V', '--variable'))) {
$i++;
LScli :: unquote_word($command_args[$i]);
$parts = explode('=', $command_args[$i]);
if (count($parts) != 2)
LScli :: usage('Invalid variable string ('.$command_args[$i].').');
if (array_key_exists($parts[0], $variables))
LScli :: usage('Variable "'.$parts[0].'" already specified.');
$variables[$parts[0]] = $parts[1];
}
elseif (in_array($command_args[$i], array('-H', '--header'))) {
$i++;
LScli :: unquote_word($command_args[$i]);
$parts = explode('=', $command_args[$i]);
if (count($parts) != 2)
LScli :: usage('Invalid header string ('.$command_args[$i].').');
if (array_key_exists($parts[0], $headers))
LScli :: usage('Header "'.$parts[0].'" already specified.');
$headers[$parts[0]] = $parts[1];
}
elseif (in_array($command_args[$i], array('-a', '--attachent'))) {
$i++;
LScli :: unquote_word($command_args[$i]);
$parts = explode(':', $command_args[$i]);
$path = $parts[0];
if (!is_file($path))
LScli :: usage('Invalid attachment "'.$command_args[$i].'": file not found.');
$attachments[$path] = count($parts) >= 2?$parts[1]:basename($path);
}
elseif ($command_args[$i] == '--bcc') {
$i++;
LScli :: unquote_word($command_args[$i]);
if (!checkEmail($command_args[$i]))
LScli :: usage('Invalid BCC recipient "'.$command_args[$i].'".');
$headers['BCC'] = isset($headers['BCC'])?ensureIsArray($headers['BCC']):[];
$headers['BCC'][] = $command_args[$i];
}
elseif ($command_args[$i] == '--cc') {
$i++;
LScli :: unquote_word($command_args[$i]);
if (!checkEmail($command_args[$i]))
LScli :: usage('Invalid CC recipient "'.$command_args[$i].'".');
$headers['CC'] = isset($headers['CC'])?ensureIsArray($headers['CC']):[];
$headers['CC'][] = $command_args[$i];
}
else if (is_null($template)) {
$template = $command_args[$i];
}
else if (checkEmail($command_args[$i])) {
$recipients[] = $command_args[$i];
}
else
LScli :: usage('Invalid recipient "'.$command_args[$i].'".');
}
if (is_null($template) || empty($recipients))
LScli :: usage('You must provide email template name and at least one recipient.');
return self :: send_mail_from_template(
$template,
$recipients,
$variables,
$headers,
$attachments
);
}
/**
* Args autocompleter for CLI test_send_mail_from_template command
*
* @param array<string> $comp_words List of already typed words of the command
* @param int $comp_word_num The command word number to autocomplete
* @param string $comp_word The command word to autocomplete
* @param array<string> $opts List of global available options
*
* @return array<string> List of available options for the word to autocomplete
**/
public static function cli_test_send_mail_from_template_autocompleter(
$comp_words, $comp_word_num, $comp_word, $opts
) {
if (isset($comp_words[$comp_word_num-1]))
switch ($comp_words[$comp_word_num-1]) {
case '-v':
case '--variable':
case '-H':
case '--header':
case '-a':
case '--attachment':
case '--bcc':
case '--cc':
return array();
break;
}
$opts = array_merge(
$opts,
array (
'-v', '--variable',
'-H', '--header',
'-a', '--attachment',
'--bcc', '--cc',
)
);
return LScli :: autocomplete_opts($opts, $comp_word);
}
}
/**
* Error Codes
*/
LSerror :: defineError('LSmail_01',
___("LSmail: Unknown template %{name}.")
);
LSerror :: defineError('LSmail_02',
___("LSmail: Template %{name} is incomplete.")
);
// LScli
LScli :: add_command(
'test_send_mail_template',
array('LSmail', 'cli_test_send_mail_template'),
'Test to send an email template',
'[template] [-V var1=value] [recipient1] [recipient2]',
array(
' - Positional arguments :',
' - email template name',
' - email recipient(s)',
'',
' - Optional arguments :',
' -V|--variable Template variable using format:',
' variable_name=variable_value',
' Multiple variables could be specified by using this',
' optional argument multiple time.',
' -H|--header Email header using format:',
' header_name=header_value',
' Multiple headers could be specified by using this',
' optional argument multiple time.',
' -a|--attachment Email attachment using format:',
' /path/to/attachment.file[:filename]',
' The filename is optional (default: using source filename).',
' Multiple attachments could be specified by using this',
' optional argument multiple time.',
' --bcc Add Blind Carbon Copy (BCC) recipient(s)',
' --cc Add Carbon Copy (CC) recipient(s)',
),
false, // This command does not need LDAP connection
array('LSmail', 'cli_test_send_mail_from_template_autocompleter')
);