displaytype = table by default
* $parameter->cols = 1 by default
*/
public function getFormattedResult(array $elements, object $parameter): string
{
//We do not add an extra table or whatever when there is a single element...
if (count($elements) < 2) {
return implode('', $elements);
}
$beforeAll = [];
$beforeAll['table'] = '
'."\n";
$afterAll['ul'] = ''."\n";
$afterAll['br'] = '';
$type = 'table';
$cols = 1;
if (!empty($parameter->displaytype)) {
$type = $parameter->displaytype;
}
if ($type == 'none') {
return implode('', $elements);
}
if (!empty($parameter->cols)) {
$cols = $parameter->cols;
}
$parameter->hpadding = !isset($parameter->hpadding) || is_null($parameter->hpadding) ? 10 : $parameter->hpadding;
$parameter->vpadding = !isset($parameter->vpadding) || is_null($parameter->vpadding) ? 10 : $parameter->vpadding;
$horizontalPadding = round($parameter->hpadding / 2);
$verticalPadding = round($parameter->vpadding / 2);
$string = $beforeAll[$type];
$a = 0;
$numrow = 1;
foreach ($elements as $key => $oneElement) {
$topPadding = $verticalPadding.'px';
$rightPadding = $horizontalPadding.'px';
$bottomPadding = $verticalPadding.'px';
$leftPadding = $horizontalPadding.'px';
if ($a == $cols) {
$string .= $afterBlock[$type];
$a = 0;
$numrow++;
}
if ($a == 0) {
$string .= str_replace('{rownum}', $numrow, $beforeBlock[$type]);
$leftPadding = '0px';
}
if ($a + 1 == $cols) $rightPadding = '0px';
if ($numrow == 1) $topPadding = '0px';
if (round(count($elements) / $cols) == $numrow) $bottomPadding = '0px';
$padding = 'padding: '.$topPadding.' '.$rightPadding.' '.$bottomPadding.' '.$leftPadding.' !important;';
$string .= str_replace('{numcol}', $a + 1, $beforeOne[$type]).$oneElement.$afterOne[$type];
$string = str_replace('{padding}', $padding, $string);
$a++;
}
while ($cols > $a) {
$string .= str_replace('{numcol}', $a + 1, $beforeOne[$type]).$afterOne[$type];
$a++;
}
$string .= $afterBlock[$type];
$string .= $afterAll[$type];
$equalwidth = intval(100 / $cols).'%';
return str_replace(['{equalwidth}'], [$equalwidth], $string);
}
/**
* This function will apply extra parameters such as part:first, ucfirst, strtolower to the $string
*/
public function formatString(&$replaceme, object $mytag): void
{
if (!empty($mytag->part)) {
$parts = explode(' ', $replaceme);
if ($mytag->part == 'last') {
$replaceme = count($parts) > 1 ? end($parts) : '';
} else {
if (is_numeric($mytag->part) && count($parts) >= $mytag->part) {
$replaceme = $parts[$mytag->part - 1];
} else {
$replaceme = reset($parts);
}
}
}
if (!empty($mytag->type)) {
if (empty($mytag->format)) {
$mytag->format = acym_translation('ACYM_DATE_FORMAT_LC3');
}
if ($mytag->type == 'date') {
$replaceme = acym_getDate(acym_getTime($replaceme), $mytag->format);
} elseif ($mytag->type == 'time') {
$replaceme = acym_getDate($replaceme, $mytag->format);
} elseif ($mytag->type == 'diff') {
try {
//We have a date? Sure?
$date = $replaceme;
if (is_numeric($date)) {
$date = acym_getDate($replaceme, '%Y-%m-%d %H:%M:%S');
}
$dateObj = new \DateTime($date);
$nowObj = new \DateTime();
$diff = $dateObj->diff($nowObj);
$replaceme = $diff->format($mytag->format);
} catch (\Exception $e) {
$replaceme = 'Error using the "diff" parameter in your tag. Please make sure the DateTime() and diff() functions are available on your server.';
}
}
}
//Two possibles keywords for that... we used to have "lower" and "upper" only but I added lowercase and uppercase as well on December 2014
if (!empty($mytag->lower) || !empty($mytag->lowercase)) {
$replaceme = function_exists('mb_strtolower') ? mb_strtolower($replaceme, 'UTF-8') : strtolower($replaceme);
}
if (!empty($mytag->upper) || !empty($mytag->uppercase)) {
$replaceme = function_exists('mb_strtoupper') ? mb_strtoupper($replaceme, 'UTF-8') : strtoupper($replaceme);
}
if (!empty($mytag->ucwords)) {
$replaceme = ucwords($replaceme);
}
if (!empty($mytag->ucfirst)) {
$replaceme = ucfirst($replaceme);
}
//Remove a character at the end of the string...
if (isset($mytag->rtrim)) {
$replaceme = empty($mytag->rtrim) ? rtrim($replaceme) : rtrim($replaceme, $mytag->rtrim);
}
if (!empty($mytag->urlencode)) {
$replaceme = urlencode($replaceme);
}
if (!empty($mytag->substr)) {
//the parameter |substr:4,6 will select the 6 characters after the 4.
$args = explode(',', $mytag->substr);
if (isset($args[1])) {
$replaceme = substr($replaceme, intval($args[0]), intval($args[1]));
} else {
$replaceme = substr($replaceme, intval($args[0]));
}
}
if (!empty($mytag->maxheight) || !empty($mytag->maxwidth)) {
$imageHelper = new ImageHelper();
$imageHelper->maxHeight = empty($mytag->maxheight) ? 999 : $mytag->maxheight;
$imageHelper->maxWidth = empty($mytag->maxwidth) ? 999 : $mytag->maxwidth;
$replaceme = $imageHelper->resizePictures($replaceme);
}
}
public function replaceVideos(string &$text): void
{
//Youtube videos
$text = preg_replace(
'#\[embed=videolink][^}]*youtube[^=]*=([^"/}]*)[^}]*}\[/embed]#i',
'',
$text
);
$text = preg_replace(
'#]*youtube\.com/embed/([^"/]*)[^>]*>[^>]*#i',
'',
$text
);
$text = preg_replace(
'#{JoooidContent[^}]*youtube[^}]*id"[^"]*"([^}"]*)"[^}]*}#i',
'',
$text
);
$text = preg_replace(
'#]*src="[^"]*youtube[^"]*embed/([^"?]*)(\?[^"]*)?"[^>]*>[^<]*#Uis',
'',
$text
);
$text = preg_replace(
'#{youtube}[^{]+v=([^{&]+)(&[^{]*)?{/youtube}#Uis',
'',
$text
);
$text = preg_replace('#{vimeo}(https://vimeo.com/[^{]+){/vimeo}#Uis', '', $text);
$text = preg_replace('#{vimeo}([^{]+){/vimeo}#Uis', '', $text);
// Vimeo iframes
if (preg_match_all('#]*src="[^"]*vimeo[^"]*/(\d+)([&/\?][^"]*)?"[^>]*>[^<]*#Uis', $text, $matches)) {
foreach ($matches[1] as $key => $match) {
$hash = acym_fileGetContent('https://vimeo.com/api/v2/video/'.$match.'.php');
// @ on purpose, the unserialize returns false if $hash isn't a serialized data, but it also throws a notice...
$hash = @unserialize($hash);
if (empty($hash)) continue;
if (strpos($matches[0][$key], ' width="') !== false) {
$extension = substr($hash[0]['thumbnail_large'], strrpos($hash[0]['thumbnail_large'], '.'));
preg_match('#width="([^"]*)"#Uis', $matches[0][$key], $width);
$replace = strpos($hash[0]['thumbnail_large'], '_') === false ? '.' : '_';
$hash[0]['thumbnail_large'] = substr($hash[0]['thumbnail_large'], 0, strrpos($hash[0]['thumbnail_large'], $replace)).'_'.$width[1].$extension;
}
$thumbnail = 'https://i.vimeocdn.com/filter/overlay?src='.urlencode($hash[0]['thumbnail_large']);
$thumbnail .= '&src='.urlencode('https://f.vimeocdn.com/p/images/crawler_play.png');
$text = str_replace(
$matches[0][$key],
'',
$text
);
}
}
//Other videos
$text = preg_replace('#\[embed=videolink][^}]*video":"([^"]*)[^}]*}\[/embed]#i', '', $text);
$text = preg_replace('#]*src="([^"]*)"[^>]*>[^>]*#i', '', $text);
}
/**
* Convert pictures base64 code into a real picture
*/
private function convertbase64pictures(string &$html): void
{
if (!preg_match_all('#]*src=("data:image/([^;]{1,5});base64[^"]*")([^>]*)>#Uis', $html, $resultspictures)) {
return;
}
//Just in case of... we will need it
$dest = ACYM_MEDIA.'resized'.DS;
acym_createDir($dest);
foreach ($resultspictures[2] as $i => $extension) {
$pictname = md5($resultspictures[1][$i]).'.'.$extension;
$picturl = ACYM_LIVE.str_replace(DS, '/', ACYM_MEDIA_FOLDER).'resized/'.$pictname;
$pictPath = $dest.$pictname;
$pictCode = trim($resultspictures[1][$i], '"');
if (file_exists($pictPath)) {
//The picture is already there... lets use it then
$html = str_replace($pictCode, $picturl, $html);
continue;
}
if (!ini_get('allow_url_fopen')) {
continue;
}
$getfunction = '';
switch ($extension) {
case 'gif':
$getfunction = 'ImageCreateFromGIF';
break;
case 'jpg':
case 'jpeg':
$getfunction = 'ImageCreateFromJPEG';
break;
case 'png':
$getfunction = 'ImageCreateFromPNG';
break;
}
//The function does not exists or we didn't find the right function... we just skip that action
if (empty($getfunction) || !function_exists($getfunction)) {
continue;
}
$img = $getfunction($pictCode);
if ($img === false) {
continue;
}
if (in_array($extension, ['gif', 'png'])) {
imagealphablending($img, false);
imagesavealpha($img, false);
}
//We display the result and then save it to avoid the issue with FTP configurations
ob_start();
switch ($extension) {
case 'gif':
$status = imagegif($img);
break;
case 'jpg':
case 'jpeg':
$status = imagejpeg($img, null, 100);
break;
case 'png':
$status = imagepng($img, null, 1);
break;
}
$imageContent = ob_get_clean();
$status = $status && acym_writeFile($pictPath, $imageContent);
//we could not save or convert the picture, we skip it
if (!$status) {
continue;
}
$html = str_replace($pictCode, $picturl, $html);
}
}
//This function will remove or replace code we should not have in an html view.
public function cleanHtml(string &$html): void
{
$this->convertbase64pictures($html);
//add line-height: 0px; in the TR style when there is only images in the cell, not extra text (new issue with gmail)
//handle a line-height automatically for
$pregreplace = [];
$pregreplace['#"]*>([^<]*]*>[ \n\s]*]*>[ \n\s]*]*>[ \n\s]*)*).)*>[ \n\s]*(]*>)?[ \n\s]*]*>[ \n\s]*(]*>)?[ \n\s]*).)*< */ *script *>#Uis"] = '';
$pregreplace["#< *iframe(?:(?!< */ *iframe *>).)*< */ *iframe *>#Uis"] = '';
// May God punish every person using Outlook, or imposing this monstrosity for his employees
$pregreplace['#(
]*>)#Uis'] = '$1';
$newbody = preg_replace(array_keys($pregreplace), $pregreplace, $html);
//we do it in two steps as this regex can break the page
if (!empty($newbody)) {
$html = $newbody;
}
$body = preg_replace_callback('/src="([^"]* [^"]*)"/Ui', [$this, 'convertSpaces'], $html);
if (!empty($body)) $html = $body;
$html = acym_cmsCleanHtml($html);
}
public function convertSpaces(array $matches): string
{
return "src='".str_replace(' ', '%20', $matches[1])."'";
}
/*
* Replace tags in all the email variables where it is possible, in text version or html version
*/
public function replaceTags(object &$email, array $tags, bool $html = false): void
{
if (empty($tags)) return;
$htmlVars = ['body'];
$textVars = [
'subject',
'AltBody',
'From',
'FromName',
'ReplyTo',
'ReplyName',
'bcc',
'cc',
'fromname',
'fromemail',
'replyname',
'replyemail',
'params',
'preheader',
];
$variables = array_merge($htmlVars, $textVars);
if ($html) {
if (empty($this->mailerHelper)) {
$this->mailerHelper = new MailerHelper();
}
$textreplace = [];
foreach ($tags as $i => $replacement) {
if (isset($textreplace[$i])) continue;
$textreplace[$i] = $this->mailerHelper->textVersion($replacement);
}
} else {
$textreplace = $tags;
}
foreach ($variables as $var) {
if (empty($email->$var)) continue;
$email->$var = $this->replaceDText($email->$var, in_array($var, $htmlVars) ? $tags : $textreplace);
}
}
public function replaceDText($text, $replacement)
{
if (is_array($text)) {
foreach ($text as &$oneCell) {
if (empty($oneCell)) continue;
$oneCell = $this->replaceDText($oneCell, $replacement);
}
} elseif (is_string($text) && !empty($text)) {
foreach ($replacement as $code => $value) {
$codes = [$code, urlencode($code)];
if (is_null($value)) {
$value = '';
}
$safePregValue = str_replace('$', '\$', $value);
foreach ($codes as $oneCode) {
// Dtext specific syntax
$text = preg_replace(
'#]+'.preg_quote($oneCode, '#').'.+[^<]*#Uis',
$safePregValue,
$text
);
// Dcontent specific syntax
$text = preg_replace(
'#(]+)data-dynamic="'.preg_quote($oneCode, '#').'"([^>]+>[^<]*]*>).+[^<]*[^<]*#Uis',
'${1}${2}'.$safePregValue.'',
$text
);
// If the code was inserted directly in the email (in the subject for example, or a copy-paste)
$text = str_replace($oneCode, $value, $text);
}
}
}
return $text;
}
/**
* This function extracts tags from the mail by checking the subject,body and altbody and returns an array of tag objects
* tagfamily is "vmproduct" for example to handle tags such as {vmproduct:23|file|price}
*/
public function extractTags(object $email, string $tagfamily): array
{
$results = [];
$match = '#(?:{|%7B)'.$tagfamily.'(?:%3A|\\:)(.*)(?:}|%7D)#Ui';
//If you add a variable there, don't forget to add it in the replaceTags function as well!
$variables = [
'subject',
'AltBody',
'body',
'From',
'FromName',
'ReplyTo',
'ReplyName',
'bcc',
'cc',
'fromname',
'fromemail',
'replyname',
'replyemail',
'params',
'preheader',
];
$found = false;
foreach ($variables as $var) {
if (empty($email->$var)) continue;
if (is_array($email->$var)) {
foreach ($email->$var as $i => $arrayField) {
if (empty($arrayField)) continue;
if (is_array($arrayField)) {
foreach ($arrayField as $a => $oneval) {
$found = preg_match_all($match, $oneval, $results[$var.$i.'-'.$a]) || $found;
if (empty($results[$var.$i.'-'.$a][0])) unset($results[$var.$i.'-'.$a]);
}
} else {
$found = preg_match_all($match, $arrayField, $results[$var.$i]) || $found;
if (empty($results[$var.$i][0])) unset($results[$var.$i]);
}
}
} else {
$found = preg_match_all($match, $email->$var, $results[$var]) || $found;
//we unset the results so that we won't handle it later... it will save some memory and processing
if (empty($results[$var][0])) unset($results[$var]);
}
}
//If we didn't find anything...
if (!$found) {
return [];
}
$tags = [];
foreach ($results as $var => $allresults) {
foreach ($allresults[0] as $i => $oneTag) {
//Don't need to process twice a tag we already have!
if (isset($tags[$oneTag])) {
continue;
}
$tags[$oneTag] = $this->extractTag($allresults[1][$i]);
}
}
return $tags;
}
/**
* Converts a tag 23|file:myfile|price into an object.
*/
public function extractTag(string $oneTag): \stdClass
{
$oneTag = str_replace(['[time]+', '[time]-'], [urlencode('[time]+'), urlencode('[time]-')], $oneTag);
$arguments = explode('|', acym_stripTags(urldecode($oneTag)));
$tag = new \stdClass();
$tag->id = $arguments[0];
$tag->default = '';
for ($i = 1, $a = count($arguments); $i < $a; $i++) {
$args = explode(':', $arguments[$i], 2);
$arg0 = trim($args[0]);
if (empty($arg0)) continue;
if (isset($args[1])) {
$tag->$arg0 = $args[1];
//We may have an extra parameter, especially for date format.
if (isset($args[2])) {
$tag->{$args[0]} .= ':'.$args[2];
}
} else {
$tag->$arg0 = true;
}
}
return $tag;
}
/**
* Wrap the text using the wrapValue
*/
public function wrapText(string $text, object $tag): string
{
if (empty($tag->wrap)) {
return $text;
}
$tag->wrap = intval($tag->wrap);
$newText = str_replace(['<', '>'], ['<', '>'], $text);
if (mb_strlen(acym_stripTags($newText)) <= $tag->wrap) {
return $newText;
}
if (!class_exists('DOMDocument', false)) {
return mb_substr(acym_stripTags($newText), 0, $tag->wrap).'…';
}
if (function_exists('libxml_use_internal_errors')) {
libxml_use_internal_errors(true);
}
$dom = new \DOMDocument('1.0', 'UTF-8');
$dom->loadHTML(
''.$newText,
LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD
);
$count = 0;
$this->truncateNode($dom, $dom, $tag->wrap, $count);
return $dom->saveHTML();
}
private function truncateNode(\DOMDocument $dom, \DOMNode $node, int $limit, int &$count): bool
{
for ($i = 0; $i < $node->childNodes->length; $i++) {
$child = $node->childNodes->item($i);
// Text node
if ($child->nodeType === XML_TEXT_NODE) {
$text = $child->nodeValue;
$len = mb_strlen($text);
if ($count + $len > $limit) {
$remaining = $limit - $count;
// Take the max allowed slice
$slice = mb_substr($text, 0, $remaining);
// Try to cut at a word boundary (spaces or punctuation)
if (preg_match('/^(.+?)([\s\p{P}]+)[^\s\p{P}]*$/u', $slice, $m)) {
$slice = rtrim($m[1]);
}
// Final assignment
$child->nodeValue = $slice.'…';
// Remove remaining siblings
while ($child->nextSibling) {
$node->removeChild($child->nextSibling);
}
return true;
}
$count += $len;
}
// Element node → recurse
if ($child->hasChildNodes() && $this->truncateNode($dom, $child, $limit, $count)) {
while ($child->nextSibling) {
$node->removeChild($child->nextSibling);
}
return true;
}
}
return false;
}
/**
* Returns a formatted version of the passed content
*
* TOP_LEFT : title on top, image with float left and covering description
* TOP_RIGHT : title on top, image with float rigth and covering description
* TITLE_IMG : image on title's left on top, description below
* TITLE_IMG_RIGHT : image on title's right on top, description below
* CENTER_IMG : title on top, image on one line and description below
* TOP_IMG : image on top, then title and description
* COL_LEFT : image on left column, title and description on right column
* COL_RIGHT : image on right column, title and description on left column
*/
public function getStandardDisplay(object $format): string
{
// By default, put float left on the picture
if (empty($format->tag->format)) {
$format->tag->format = 'TOP_LEFT';
}
if (!in_array($format->tag->format, ['TOP_LEFT', 'TOP_RIGHT', 'TITLE_IMG', 'TITLE_IMG_RIGHT', 'CENTER_IMG', 'TOP_IMG', 'COL_LEFT', 'COL_RIGHT'])) {
$format->tag->format = 'TOP_LEFT';
}
$invertValues = [
'TOP_LEFT' => 'TOP_RIGHT',
'TITLE_IMG' => 'TITLE_IMG_RIGHT',
'COL_LEFT' => 'COL_RIGHT',
'TOP_RIGHT' => 'TOP_LEFT',
'TITLE_IMG_RIGHT' => 'TITLE_IMG',
'COL_RIGHT' => 'COL_LEFT',
];
if (!empty($format->tag->invert) && !empty($invertValues[$format->tag->format])) {
$format->tag->format = $invertValues[$format->tag->format];
}
// Get the image with float left/right or no style
$image = '';
if (!empty($format->imagePath)) {
$style = '';
$linkStyle = '';
if (in_array($format->tag->format, ['TOP_LEFT', 'TITLE_IMG'])) {
$style = 'left';
} elseif (in_array($format->tag->format, ['TOP_RIGHT', 'TITLE_IMG_RIGHT'])) {
$style = 'right';
}
if (!empty($style)) {
$linkStyle = 'style="float:'.$style.';"';
if ($style === 'left') {
$style = 'style="float:left; margin-right: 7px; margin-bottom: 7px;"';
} else {
$style = 'style="float:right; margin-left: 7px; margin-bottom: 7px;"';
}
}
preg_match('#src="([^"]+)"#Uis', $format->imagePath, $matches);
if (!empty($matches[1])) $format->imagePath = $matches[1];
$altImage = !empty($format->altImage) ? $format->altImage : '';
$image = '';
if (!empty($format->imageCaption) && !in_array($format->tag->format, ['TITLE_IMG', 'TITLE_IMG_RIGHT'])) {
$image .= '
'.esc_html($format->imageCaption).'
';
}
}
// If TITLE_IMG, add the image to the title
$result = '';
if (in_array($format->tag->format, ['TITLE_IMG', 'TITLE_IMG_RIGHT'])) {
$format->title = $image.$format->title;
$image = '';
}
if (!empty($format->link) && !empty($image) && !empty($format->tag->clickableimg)) {
$image = ''.$image.'';
}
// If the image should be displayed before the title, do it
if ($format->tag->format === 'TOP_IMG' && !empty($image)) {
$result = $image;
$image = '';
}
// If we want to keep the left/right column for the image, put the whole article in a table
if (in_array($format->tag->format, ['COL_LEFT', 'COL_RIGHT'])) {
$maxWidth = empty($format->tag->maxwidth) ? '' : ' width: '.$format->tag->maxwidth.'px;';
if (empty($image)) {
$format->tag->format = 'TOP_LEFT';
} else {
$result = '
';
if ($format->tag->format === 'COL_LEFT') {
$result = '
';
$result .= $image.'
';
}
}
}
// Display the title
if (!empty($format->title)) {
if (!empty($format->link) && !empty($format->tag->clickable)) {
if (empty($format->tag->type) || $format->tag->type !== 'title') {
$format->title = '
';
// Display the main content based on the chosen format
if (in_array($format->tag->format, ['TOP_LEFT', 'TOP_RIGHT', 'TITLE_IMG', 'TITLE_IMG_RIGHT', 'TOP_IMG'])) {
if (!empty($image) || !empty($format->description)) {
$result .= $rowText.$image.$format->description.$endRow;
}
} elseif ($format->tag->format == 'CENTER_IMG') {
if (!empty($image)) {
$result .= '
'.$image.$endRow;
}
if (!empty($format->description)) {
$result .= $rowText.$format->description.$endRow;
}
} elseif (in_array($format->tag->format, ['COL_LEFT', 'COL_RIGHT'])) {
if (!empty($format->description)) {
$result .= $rowText.$format->description.$endRow;
}
if ($format->tag->format === 'COL_RIGHT') {
$result .= '
'.$image;
}
$result .= '
';
}
// Add the custom fields on 1 or 2 columns, with or without the labels
if (!empty($format->customFields)) {
$result .= '
', $text);
$text = preg_replace('#