Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests Activity

add unit test for image in email with src=../media/ or src=base64

Browse Source
This commit is contained in:
Florian HENRY
2023-12-13 11:31:42 +01:00
parent 9bbd285c3a
commit 82c49e62d1
2 changed files with 134 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
htdocs/core/class/CMailFile.class.php
View File

@@ -263,12 +263,23 @@ class CMailFile
// This convert an embedd file with src="/viewimage.php?modulepart... into a cid link // This convert an embedd file with src="/viewimage.php?modulepart... into a cid link
// TODO Exclude viewimage used for the read tracker ? // TODO Exclude viewimage used for the read tracker ?
$findimg = $this->findHtmlImages($dolibarr_main_data_root.'/medias'); $findimg = $this->findHtmlImages($dolibarr_main_data_root.'/medias');
if ($findimg<0) {
dol_syslog("CMailFile::CMailfile: Error on findHtmlImages");
$this->error = 'ErrorInAddAttachementsImageBAseOnMedia';
return;
}
} }
if (!empty($conf->global->MAIN_MAIL_ADD_INLINE_IMAGES_IF_DATA)) { if (!empty($conf->global->MAIN_MAIL_ADD_INLINE_IMAGES_IF_DATA)) {
// Search into the body for <img src="data:image/ext;base64,..." to replace them with an embedded file // Search into the body for <img src="data:image/ext;base64,..." to replace them with an embedded file
// This convert an embedded file with src="data:image... into a cid link + attached file // This convert an embedded file with src="data:image... into a cid link + attached file
$findimg = $findimg + $this->findHtmlImagesIsSrcData($upload_dir_tmp); $resultImageData = $this->findHtmlImagesIsSrcData($upload_dir_tmp);
if ($resultImageData<0) {
dol_syslog("CMailFile::CMailfile: Error on findHtmlImagesInSrcData");
$this->error = 'ErrorInAddAttachementsImageBAseOnMedia';
return;
}
$findimg += $resultImageData;
} }
// Set atleastoneimage if there is at least one embedded file (into ->html_images) // Set atleastoneimage if there is at least one embedded file (into ->html_images)
@@ -1847,7 +1858,7 @@ class CMailFile
// We search (into mail body this->html), if we find some strings like "... file=xxx.img" // We search (into mail body this->html), if we find some strings like "... file=xxx.img"
// For example when: // For example when:
// <img alt="" src="/viewimage.php?modulepart=medias&amp;entity=1&amp;file=image/picture.jpg" style="height:356px; width:1040px" /> // <img alt="" src="/src="data:image....;base64,...." />
$matches = array(); $matches = array();
preg_match_all('/src="data:image\/('.implode('|', $extensions).');base64,([^"]+)"/Ui', $this->html, $matches); // If "xxx.ext" or 'xxx.ext' found preg_match_all('/src="data:image\/('.implode('|', $extensions).');base64,([^"]+)"/Ui', $this->html, $matches); // If "xxx.ext" or 'xxx.ext' found

182
test/phpunit/CMailFileTest.php
View File

@@ -23,18 +23,19 @@
* \remarks To run this script as CLI: phpunit filename.php * \remarks To run this script as CLI: phpunit filename.php
*/ */
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
//define('TEST_DB_FORCE_TYPE','mysql'); // This is to force using mysql driver //define('TEST_DB_FORCE_TYPE','mysql'); // This is to force using mysql driver
//require_once 'PHPUnit/Autoload.php'; //require_once 'PHPUnit/Autoload.php';
require_once dirname(__FILE__).'/../../htdocs/master.inc.php'; require_once dirname(__FILE__).'/../../htdocs/master.inc.php';
require_once dirname(__FILE__).'/../../htdocs/core/class/CMailFile.class.php'; require_once dirname(__FILE__).'/../../htdocs/core/class/CMailFile.class.php';
require_once dirname(__FILE__).'/../../htdocs/core/lib/files.lib.php';
if (empty($user->id)) { if (empty($user->id)) {
print "Load permissions for admin user nb 1\n"; print "Load permissions for admin user nb 1\n";
$user->fetch(1); $user->fetch(1);
$user->getrights(); $user->getrights();
} }
$conf->global->MAIN_DISABLE_ALL_MAILS=1; $conf->global->MAIN_DISABLE_ALL_MAILS = 1;
/** /**
@@ -42,7 +43,7 @@ $conf->global->MAIN_DISABLE_ALL_MAILS=1;
* *
* @backupGlobals disabled * @backupGlobals disabled
* @backupStaticAttributes enabled * @backupStaticAttributes enabled
* @remarks backupGlobals must be disabled to have db,conf,user and lang not erased. * @remarks backupGlobals must be disabled to have db,conf,user and lang not erased.
*/ */
class CMailFileTest extends PHPUnit\Framework\TestCase class CMailFileTest extends PHPUnit\Framework\TestCase
{ {
@@ -62,13 +63,13 @@ class CMailFileTest extends PHPUnit\Framework\TestCase
parent::__construct(); parent::__construct();
//$this->sharedFixture //$this->sharedFixture
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
$this->savconf=$conf; $this->savconf = $conf;
$this->savuser=$user; $this->savuser = $user;
$this->savlangs=$langs; $this->savlangs = $langs;
$this->savdb=$db; $this->savdb = $db;
print __METHOD__." db->type=".$db->type." user->id=".$user->id; print __METHOD__ . " db->type=" . $db->type . " user->id=" . $user->id;
//print " - db ".$db->db; //print " - db ".$db->db;
print "\n"; print "\n";
} }
@@ -80,23 +81,23 @@ class CMailFileTest extends PHPUnit\Framework\TestCase
*/ */
public static function setUpBeforeClass(): void public static function setUpBeforeClass(): void
{ {
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
$db->begin(); // This is to have all actions inside a transaction even if test launched without suite. $db->begin(); // This is to have all actions inside a transaction even if test launched without suite.
print __METHOD__."\n"; print __METHOD__ . "\n";
} }
/** /**
* tearDownAfterClass * tearDownAfterClass
* *
* @return void * @return void
*/ */
public static function tearDownAfterClass(): void public static function tearDownAfterClass(): void
{ {
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
$db->rollback(); $db->rollback();
print __METHOD__."\n"; print __METHOD__ . "\n";
} }
/** /**
@@ -106,24 +107,25 @@ class CMailFileTest extends PHPUnit\Framework\TestCase
*/ */
protected function setUp(): void protected function setUp(): void
{ {
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
$conf=$this->savconf; $conf = $this->savconf;
$user=$this->savuser; $user = $this->savuser;
$langs=$this->savlangs; $langs = $this->savlangs;
$db=$this->savdb; $db = $this->savdb;
$conf->global->MAIN_DISABLE_ALL_MAILS=1; // If I comment/remove this lien, unit test still works alone but failed when ran from AllTest. Don't know why. $conf->global->MAIN_DISABLE_ALL_MAILS = 1; // If I comment/remove this lien, unit test still works alone but failed when ran from AllTest. Don't know why.
print __METHOD__."\n"; print __METHOD__ . "\n";
} }
/** /**
* End phpunit tests * End phpunit tests
* *
* @return void * @return void
*/ */
protected function tearDown(): void protected function tearDown(): void
{ {
print __METHOD__."\n"; print __METHOD__ . "\n";
} }
/** /**
@@ -133,16 +135,16 @@ class CMailFileTest extends PHPUnit\Framework\TestCase
*/ */
public function testCMailFileText() public function testCMailFileText()
{ {
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
$conf=$this->savconf; $conf = $this->savconf;
$user=$this->savuser; $user = $this->savuser;
$langs=$this->savlangs; $langs = $this->savlangs;
$db=$this->savdb; $db = $this->savdb;
$localobject=new CMailFile('Test', 'test@test.com', 'from@from.com', 'Message txt', array(), array(), array(), '', '', 1, 0); $localobject = new CMailFile('Test', 'test@test.com', 'from@from.com', 'Message txt', array(), array(), array(), '', '', 1, 0);
$result=$localobject->sendfile(); $result = $localobject->sendfile();
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertFalse($result); // False because mail send disabled $this->assertFalse($result); // False because mail send disabled
return $result; return $result;
@@ -155,54 +157,112 @@ class CMailFileTest extends PHPUnit\Framework\TestCase
*/ */
public function testCMailFileStatic() public function testCMailFileStatic()
{ {
global $conf,$user,$langs,$db; global $conf, $user, $langs, $db;
$conf=$this->savconf; $conf = $this->savconf;
$user=$this->savuser; $user = $this->savuser;
$langs=$this->savlangs; $langs = $this->savlangs;
$db=$this->savdb; $db = $this->savdb;
$localobject=new CMailFile('', '', '', ''); $localobject = new CMailFile('', '', '', '');
$src='John Doe <john@doe.com>'; $src = 'John Doe <john@doe.com>';
$result=$localobject->getValidAddress($src, 0); $result = $localobject->getValidAddress($src, 0);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, 'John Doe <john@doe.com>'); $this->assertEquals($result, 'John Doe <john@doe.com>');
$src='John Doe <john@doe.com>'; $src = 'John Doe <john@doe.com>';
$result=$localobject->getValidAddress($src, 1); $result = $localobject->getValidAddress($src, 1);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, '<john@doe.com>'); $this->assertEquals($result, '<john@doe.com>');
$src='John Doe <john@doe.com>'; $src = 'John Doe <john@doe.com>';
$result=$localobject->getValidAddress($src, 2); $result = $localobject->getValidAddress($src, 2);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, 'john@doe.com'); $this->assertEquals($result, 'john@doe.com');
$src='John Doe <john@doe.com>'; $src = 'John Doe <john@doe.com>';
$result=$localobject->getValidAddress($src, 3, 0); $result = $localobject->getValidAddress($src, 3, 0);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, '"John Doe" <john@doe.com>'); $this->assertEquals($result, '"John Doe" <john@doe.com>');
$src='John Doe <john@doe.com>'; $src = 'John Doe <john@doe.com>';
$result=$localobject->getValidAddress($src, 3, 1); $result = $localobject->getValidAddress($src, 3, 1);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, '"=?UTF-8?B?Sm9obiBEb2U=?=" <john@doe.com>'); $this->assertEquals($result, '"=?UTF-8?B?Sm9obiBEb2U=?=" <john@doe.com>');
$src='John Doe <john@doe.com>'; $src = 'John Doe <john@doe.com>';
$result=$localobject->getValidAddress($src, 4); $result = $localobject->getValidAddress($src, 4);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, 'John Doe'); $this->assertEquals($result, 'John Doe');
$src='John Doe <john@doe.com>, John Doe2 <john@doe3.com>, John Doe3 <john@doe2.com>'; $src = 'John Doe <john@doe.com>, John Doe2 <john@doe3.com>, John Doe3 <john@doe2.com>';
$result=$localobject->getValidAddress($src, 4); $result = $localobject->getValidAddress($src, 4);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, 'John Doe,John Doe2,John Doe3'); $this->assertEquals($result, 'John Doe,John Doe2,John Doe3');
$src='John Doe <john@doe.com>, John Doe2 <john@doe3.com>, John Doe3 <john@doe2.com>'; $src = 'John Doe <john@doe.com>, John Doe2 <john@doe3.com>, John Doe3 <john@doe2.com>';
$result=$localobject->getValidAddress($src, 4, 0, 2); $result = $localobject->getValidAddress($src, 4, 0, 2);
print __METHOD__." result=".$result."\n"; print __METHOD__ . " result=" . $result . "\n";
$this->assertEquals($result, 'John Doe,John Doe2...'); $this->assertEquals($result, 'John Doe,John Doe2...');
return $result; return $result;
} }
public function testCMailFileHTMLWithImage()
{
global $conf, $user, $langs, $db;
$conf = $this->savconf;
$user = $this->savuser;
$langs = $this->savlangs;
$db = $this->savdb;
$conf->global->MAIN_MAIL_ADD_INLINE_IMAGES_IF_IN_MEDIAS = 1;
$conf->global->MAIN_MAIL_ADD_INLINE_IMAGES_IF_DATA = 1;
dol_delete_dir_recursive(DOL_DATA_ROOT . '/medias/image');
dol_mkdir(DOL_DATA_ROOT . '/medias/image');
dol_copy(dirname(__FILE__) . '/img250x20.png', DOL_DATA_ROOT . '/medias/image/img250x20.png');
$msg = '<html><body>';
$msg .= '<img alt="" src="/viewimage.php?modulepart=medias&amp;entity=1&amp;file=image/img250x20.png" style="height:39px; width:150px" />';
$msg .= ' <p>From wikipedia</p> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==" alt="Red dot" />';
$msg .= '</body></html>';
$localobject = new CMailFile('Test', 'test@test.com', 'from@from.com', $msg, array(), array(), array(), '', '', 0, -1,'','','','','standard','','/tmp');
$result = count($localobject->html_images);
print __METHOD__ . " result count image detected in the mail=" . $result . "\n";
$this->assertEquals($result, 2);
foreach ($localobject->html_images as $i => $val)
if ($localobject->html_images[$i]) {
if ($localobject->html_images[$i]['type'] == 'cidfromdata') {
if (preg_match('/img250x20\.png/i',$localobject->html_images[$i]['fullpath'])) {
print __METHOD__ . " content type must be image png =" . $localobject->html_images[$i]['content_type'] . "\n";
$this->assertEquals($localobject->html_images[$i]['content_type'], 'image/png');
print __METHOD__ . " type must be cidfromurl =" . $localobject->html_images[$i]['type'] . "\n";
$this->assertEquals($localobject->html_images[$i]['type'], 'cidfromurl');
$fileSize=9744;
print __METHOD__ . " File size must be =" . $fileSize . "\n";
$this->assertEquals(dol_filesize($localobject->html_images[$i]['fullpath']), $fileSize);
} elseif (preg_match('/\.png/i',$localobject->html_images[$i]['fullpath'])) {
print __METHOD__ . " content type must be image png =" . $localobject->html_images[$i]['content_type'] . "\n";
$this->assertEquals($localobject->html_images[$i]['content_type'], 'image/png');
print __METHOD__ . " type must be cidfromdata =" . $localobject->html_images[$i]['type'] . "\n";
$this->assertEquals($localobject->html_images[$i]['type'], 'cidfromdata');
$fileSize=85;
print __METHOD__ . " File size must be =" . $fileSize . "\n";
$this->assertEquals(dol_filesize($localobject->html_images[$i]['fullpath']), $fileSize);
}
}
}
return $result;
}
} }