forked from Wavyzz/dolibarr
Qual: Refactor CodingPhpTest / CommonClassTest - less verbosity, but better when error (#28388)
* Qual: CommonClassTest - less verbosity, but better when error # Qual: CommonClassTest - less verbosity, but better when error - Report the test method and parameters in case of error. - Less verbosity about setup. - $_ENV was empty array, replaced with getenv() * Qual: Refactor CodingPhpTest # Qual: Refactor CodingPhpTest - Use dataprovider (better progress report, better errors, better continuation) - Use dol_dir_list's exclude_filter capability (do not traverse the excluded dirs) - Reduce debug output from dolibarr.log (not really relevant for these tests). * Fix: References to loop variables outside loop # Fix: References to loop variables outside loop The test referenced some undefined variables outside foreach loops ($val[0]) * Update CommonClassTest.class.php --------- Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>
This commit is contained in:
@@ -81,503 +81,515 @@ $conf->global->MAIN_DISABLE_ALL_MAILS = 1;
|
|||||||
*/
|
*/
|
||||||
class CodingPhpTest extends CommonClassTest
|
class CodingPhpTest extends CommonClassTest
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* Return list of files for which to verify Php checks
|
||||||
|
*
|
||||||
|
* @return array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string} List of php files to check (dol_dir_list)
|
||||||
|
*/
|
||||||
|
public function phpFilesProvider()
|
||||||
|
{
|
||||||
|
// File functions are needed
|
||||||
|
include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
|
||||||
|
|
||||||
|
|
||||||
|
$excludeRegexList
|
||||||
|
= array(
|
||||||
|
'\/includes\/',
|
||||||
|
'\/install\/doctemplates\/websites\/',
|
||||||
|
'\/custom\/',
|
||||||
|
'\/dolimed',
|
||||||
|
'\/nltechno',
|
||||||
|
'\/teclib',
|
||||||
|
);
|
||||||
|
$fullRegex = '(?:'.implode('|', $excludeRegexList).')';
|
||||||
|
$filesarray = dol_dir_list(DOL_DOCUMENT_ROOT, 'files', 1, '\.php', [$fullRegex], 'fullname', SORT_ASC, 0, 1, '', 1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
$filteredArray = array_filter(
|
||||||
|
$filesarray,
|
||||||
|
static function($file) use (&$fullRegex) {
|
||||||
|
return !preg_match($fullRegex, $file['relativename']);
|
||||||
|
}
|
||||||
|
));
|
||||||
|
*/
|
||||||
|
return array_map(function ($value) {
|
||||||
|
return array($value);
|
||||||
|
}, $filesarray);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* testPHP
|
* testPHP
|
||||||
*
|
*
|
||||||
|
* @param array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string} $file File information
|
||||||
* @return string
|
* @return string
|
||||||
|
*
|
||||||
|
* @dataProvider phpFilesProvider
|
||||||
*/
|
*/
|
||||||
public function testPHP()
|
public function testPHP($file)
|
||||||
{
|
{
|
||||||
global $conf,$user,$langs,$db;
|
$this->nbLinesToShow = 1;
|
||||||
$conf = $this->savconf;
|
//print 'Check php file '.$file['relativename']."\n";
|
||||||
$user = $this->savuser;
|
$filecontent = file_get_contents($file['fullname']);
|
||||||
$langs = $this->savlangs;
|
|
||||||
$db = $this->savdb;
|
|
||||||
|
|
||||||
include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
|
$this->verifyIsModuleEnabledOk($filecontent, "htdocs/{$file['relativename']}");
|
||||||
$filesarray = dol_dir_list(DOL_DOCUMENT_ROOT, 'files', 1, '\.php', null, 'fullname', SORT_ASC, 0, 1, '', 1);
|
|
||||||
|
|
||||||
foreach ($filesarray as $key => $file) {
|
if (preg_match('/\.class\.php/', $file['relativename'])
|
||||||
if (preg_match('/\/(htdocs|html)\/includes\//', $file['fullname'])) {
|
|| preg_match('/boxes\/box_/', $file['relativename'])
|
||||||
continue;
|
|| preg_match('/modules\/.*\/doc\/(doc|pdf)_/', $file['relativename'])
|
||||||
}
|
|| preg_match('/modules\/(import|mailings|printing)\//', $file['relativename'])
|
||||||
if (preg_match('/\/(htdocs|html)\/install\/doctemplates\/websites\//', $file['fullname'])) {
|
|| in_array($file['name'], array('modules_boxes.php', 'TraceableDB.php'))) {
|
||||||
continue;
|
// Check into Class files
|
||||||
}
|
if (! in_array($file['name'], array(
|
||||||
if (preg_match('/\/(htdocs|html)\/custom\//', $file['fullname'])) {
|
'api.class.php',
|
||||||
continue;
|
'commonobject.class.php',
|
||||||
}
|
'conf.class.php',
|
||||||
if (preg_match('/\/(htdocs|html)\/dolimed/', $file['fullname'])) {
|
'html.form.class.php',
|
||||||
continue;
|
'translate.class.php',
|
||||||
}
|
'utils.class.php',
|
||||||
if (preg_match('/\/(htdocs|html)\/nltechno/', $file['fullname'])) {
|
'TraceableDB.php',
|
||||||
continue;
|
'multicurrency.class.php'
|
||||||
}
|
))) {
|
||||||
if (preg_match('/\/(htdocs|html)\/teclib/', $file['fullname'])) {
|
// Must not find $db->
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
//print 'Check php file '.$file['relativename']."\n";
|
|
||||||
$filecontent = file_get_contents($file['fullname']);
|
|
||||||
|
|
||||||
$this->verifyIsModuleEnabledOk($filecontent, "htdocs/{$file['relativename']}");
|
|
||||||
|
|
||||||
if (preg_match('/\.class\.php/', $file['relativename'])
|
|
||||||
|| preg_match('/boxes\/box_/', $file['relativename'])
|
|
||||||
|| preg_match('/modules\/.*\/doc\/(doc|pdf)_/', $file['relativename'])
|
|
||||||
|| preg_match('/modules\/(import|mailings|printing)\//', $file['relativename'])
|
|
||||||
|| in_array($file['name'], array('modules_boxes.php', 'TraceableDB.php'))) {
|
|
||||||
// Check into Class files
|
|
||||||
if (! in_array($file['name'], array(
|
|
||||||
'api.class.php',
|
|
||||||
'commonobject.class.php',
|
|
||||||
'conf.class.php',
|
|
||||||
'html.form.class.php',
|
|
||||||
'translate.class.php',
|
|
||||||
'utils.class.php',
|
|
||||||
'TraceableDB.php',
|
|
||||||
'multicurrency.class.php'
|
|
||||||
))) {
|
|
||||||
// Must not find $db->
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
// Check string $db-> inside a class.php file (it should be $this->db-> into such classes)
|
|
||||||
preg_match_all('/'.preg_quote('$db->', '/').'/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found string $db-> into a .class.php file in '.$file['relativename'].'. Inside a .class file, you should use $this->db-> instead.');
|
|
||||||
//exit;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (preg_match('/\.class\.php/', $file['relativename']) && ! in_array($file['relativename'], array(
|
|
||||||
'adherents/canvas/actions_adherentcard_common.class.php',
|
|
||||||
'contact/canvas/actions_contactcard_common.class.php',
|
|
||||||
'compta/facture/class/facture.class.php',
|
|
||||||
'core/class/commonobject.class.php',
|
|
||||||
'core/class/extrafields.class.php',
|
|
||||||
'core/class/html.form.class.php',
|
|
||||||
'core/class/html.formfile.class.php',
|
|
||||||
'core/class/html.formcategory.class.php',
|
|
||||||
'core/class/html.formmail.class.php',
|
|
||||||
'core/class/html.formother.class.php',
|
|
||||||
'core/class/html.formsms.class.php',
|
|
||||||
'core/class/html.formticket.class.php',
|
|
||||||
'core/class/utils.class.php',
|
|
||||||
'fourn/class/fournisseur.facture.class.php',
|
|
||||||
'societe/canvas/actions_card_common.class.php',
|
|
||||||
'societe/canvas/individual/actions_card_individual.class.php',
|
|
||||||
'ticket/class/actions_ticket.class.php',
|
|
||||||
'ticket/class/ticket.class.php',
|
|
||||||
'webportal/class/context.class.php',
|
|
||||||
'webportal/class/html.formcardwebportal.class.php',
|
|
||||||
'webportal/class/html.formlistwebportal.class.php',
|
|
||||||
'webportal/controllers/document.controller.class.php',
|
|
||||||
'workstation/class/workstation.class.php',
|
|
||||||
))) {
|
|
||||||
// Must not find GETPOST
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
// Check string GETPOSTFLOAT a class.php file (should not be found into classes)
|
|
||||||
preg_match_all('/GETPOST\(["\'](....)/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if (in_array($val[1], array('lang', 'forc', 'mass', 'conf'))) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
//var_dump($val);
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found string GETPOST into a .class.php file in '.$file['relativename'].'.');
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Check into Include files
|
|
||||||
if (! in_array($file['name'], array(
|
|
||||||
'objectline_view.tpl.php',
|
|
||||||
'extrafieldsinexport.inc.php',
|
|
||||||
'extrafieldsinimport.inc.php',
|
|
||||||
'DolQueryCollector.php',
|
|
||||||
'DoliStorage.php'
|
|
||||||
))) {
|
|
||||||
// Must not found $this->db->
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
// Check string $this->db-> into a non class.php file (it should be $db-> into such classes)
|
|
||||||
preg_match_all('/'.preg_quote('$this->db->', '/').'/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found string "$this->db->" in '.$file['relativename']);
|
|
||||||
//exit;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check we don't miss top_httphead() into any ajax pages
|
|
||||||
if (preg_match('/ajax\//', $file['relativename'])) {
|
|
||||||
print "Analyze ajax page ".$file['relativename']."\n";
|
|
||||||
$ok = true;
|
$ok = true;
|
||||||
$matches = array();
|
$matches = array();
|
||||||
preg_match_all('/top_httphead/', $filecontent, $matches, PREG_SET_ORDER);
|
// Check string $db-> inside a class.php file (it should be $this->db-> into such classes)
|
||||||
if (count($matches) == 0) {
|
preg_match_all('/'.preg_quote('$db->', '/').'/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
$ok = false;
|
$ok = false;
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
$this->assertTrue($ok, 'Did not find top_httphead into the ajax page '.$file['relativename']);
|
$this->assertTrue($ok, 'Found string $db-> into a .class.php file in '.$file['relativename'].'. Inside a .class file, you should use $this->db-> instead.');
|
||||||
//exit;
|
//exit;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if a var_dump has been forgotten
|
if (preg_match('/\.class\.php/', $file['relativename']) && ! in_array($file['relativename'], array(
|
||||||
if (!preg_match('/test\/phpunit/', $file['fullname'])) {
|
'adherents/canvas/actions_adherentcard_common.class.php',
|
||||||
if (! in_array($file['name'], array('class.nusoap_base.php'))) {
|
'contact/canvas/actions_contactcard_common.class.php',
|
||||||
$ok = true;
|
'compta/facture/class/facture.class.php',
|
||||||
$matches = array();
|
'core/class/commonobject.class.php',
|
||||||
preg_match_all('/(.)\s*var_dump\(/', $filecontent, $matches, PREG_SET_ORDER);
|
'core/class/extrafields.class.php',
|
||||||
//var_dump($matches);
|
'core/class/html.form.class.php',
|
||||||
foreach ($matches as $key => $val) {
|
'core/class/html.formfile.class.php',
|
||||||
if ($val[1] != '/' && $val[1] != '*') {
|
'core/class/html.formcategory.class.php',
|
||||||
$ok = false;
|
'core/class/html.formmail.class.php',
|
||||||
break;
|
'core/class/html.formother.class.php',
|
||||||
}
|
'core/class/html.formsms.class.php',
|
||||||
break;
|
'core/class/html.formticket.class.php',
|
||||||
|
'core/class/utils.class.php',
|
||||||
|
'fourn/class/fournisseur.facture.class.php',
|
||||||
|
'societe/canvas/actions_card_common.class.php',
|
||||||
|
'societe/canvas/individual/actions_card_individual.class.php',
|
||||||
|
'ticket/class/actions_ticket.class.php',
|
||||||
|
'ticket/class/ticket.class.php',
|
||||||
|
'webportal/class/context.class.php',
|
||||||
|
'webportal/class/html.formcardwebportal.class.php',
|
||||||
|
'webportal/class/html.formlistwebportal.class.php',
|
||||||
|
'webportal/controllers/document.controller.class.php',
|
||||||
|
'workstation/class/workstation.class.php',
|
||||||
|
))) {
|
||||||
|
// Must not find GETPOST
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
// Check string GETPOSTFLOAT a class.php file (should not be found into classes)
|
||||||
|
preg_match_all('/GETPOST\(["\'](....)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if (in_array($val[1], array('lang', 'forc', 'mass', 'conf'))) {
|
||||||
|
continue;
|
||||||
}
|
}
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
//var_dump($val);
|
||||||
$this->assertTrue($ok, 'Found string var_dump that is not just after /* or // in '.$file['relativename']);
|
|
||||||
//exit;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check get_class followed by __METHOD__
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/'.preg_quote('get_class($this)."::".__METHOD__', '/').'/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found string get_class($this)."::".__METHOD__ that must be replaced with __METHOD__ only in '.$file['relativename']);
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Check string $this->db->idate without quotes
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/(..)\s*\.\s*\$this->db->idate\(/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if ($val[1] != '\'"' && $val[1] != '\'\'') {
|
|
||||||
$ok = false;
|
$ok = false;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found string GETPOST into a .class.php file in '.$file['relativename'].'.');
|
||||||
}
|
}
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
} else {
|
||||||
$this->assertTrue($ok, 'Found a $this->db->idate to forge a sql request without quotes around this date field '.$file['relativename']);
|
// Check into Include files
|
||||||
//exit;
|
if (! in_array($file['name'], array(
|
||||||
|
'objectline_view.tpl.php',
|
||||||
|
'extrafieldsinexport.inc.php',
|
||||||
|
'extrafieldsinimport.inc.php',
|
||||||
// Check sql string DELETE|OR|AND|WHERE|INSERT ... yyy = ".$xxx
|
'DolQueryCollector.php',
|
||||||
// with xxx that is not 'thi' (for $this->db->sanitize) and 'db-' (for $db->sanitize). It means we forget a ' if string, or an (int) if int, when forging sql request.
|
'DoliStorage.php'
|
||||||
$ok = true;
|
))) {
|
||||||
$matches = array();
|
// Must not found $this->db->
|
||||||
preg_match_all('/(DELETE|OR|AND|WHERE|INSERT)\s.*([^\s][^\s][^\s])\s*=\s*(\'|")\s*\.\s*\$(...)/', $filecontent, $matches, PREG_SET_ORDER);
|
$ok = true;
|
||||||
foreach ($matches as $key => $val) {
|
$matches = array();
|
||||||
if ($val[2] == 'ity' && $val[4] == 'con') { // exclude entity = ".$conf->entity
|
// Check string $this->db-> into a non class.php file (it should be $db-> into such classes)
|
||||||
continue;
|
preg_match_all('/'.preg_quote('$this->db->', '/').'/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
}
|
foreach ($matches as $key => $val) {
|
||||||
if ($val[2] == 'ame' && $val[4] == 'db-' && preg_match('/WHERE name/', $val[0])) { // exclude name = ".$db->encrypt(
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if ($val[2] == 'ame' && $val[4] == 'thi' && preg_match('/WHERE name/', $val[0])) { // exclude name = ".$this->db->encrypt(
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
var_dump($matches);
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non quoted or not casted var into sql request '.$file['relativename'].' - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Check that forged sql string is using ' instead of " as string PHP quotes
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/\$sql \.= \'\s*VALUES.*\$/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
//if ($val[1] != '\'"' && $val[1] != '\'\'') {
|
|
||||||
var_dump($matches);
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
//}
|
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found a forged SQL string that mix on same line the use of \' for PHP string and PHP variables into file '.$file['relativename'].' Use " to forge PHP string like this: $sql = "SELECT ".$myvar...');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Check that forged sql string is using ' instead of " as string PHP quotes
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/\$sql \.?= \'SELECT.*\$/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
var_dump($matches);
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a forged SQL string that mix on same line the use of \' for PHP string and PHP variables into file '.$file['relativename'].' Use " to forge PHP string like this: $sql = "SELECT ".$myvar...');
|
|
||||||
|
|
||||||
// Check sql string VALUES ... , ".$xxx
|
|
||||||
// with xxx that is not 'db-' (for $db->escape). It means we forget a ' if string, or an (int) if int, when forging sql request.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/(VALUES).*,\s*"\s*\.\s*\$(...)/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if ($val[1] == 'VALUES' && $val[2] == 'db-') { // exclude $db->escape(
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if ($val[1] == 'VALUES' && $val[2] == 'thi' && preg_match('/this->db->encrypt/', $val[0])) { // exclude ".$this->db->encrypt(
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
var_dump($matches);
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non quoted or not casted var into sql request '.$file['relativename'].' - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Check '".$xxx non escaped
|
|
||||||
|
|
||||||
// Check string ='".$this->xxx with xxx that is not 'escape'. It means we forget a db->escape when forging sql request.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/=\s*\'"\s*\.\s*\$this->(....)/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if ($val[1] != 'db->' && $val[1] != 'esca') {
|
|
||||||
$ok = false;
|
$ok = false;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found string "$this->db->" in '.$file['relativename']);
|
||||||
|
//exit;
|
||||||
}
|
}
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non escaped string in building of a sql request (case 1) in '.$file['relativename'].' - Bad.');
|
|
||||||
|
|
||||||
// Check string sql|set|WHERE|...'".$yyy->xxx with xxx that is not 'escape', 'idate', .... It means we forget a db->escape when forging sql request.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/(sql|SET|WHERE|INSERT|VALUES|LIKE).+\s*\'"\s*\.\s*\$(.......)/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if (! in_array($val[2], array('this->d', 'this->e', 'db->esc', 'dbs->es', 'dbs->id', 'mydb->e', 'dbsessi', 'db->ida', 'escaped', 'exclude', 'include'))) {
|
|
||||||
$ok = false; // This will generate error
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non escaped string in building of a sql request (case 2) in '.$file['relativename'].': '.$val[0].' - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Check string sql|set...'.$yyy->xxx with xxx that is not 'escape', 'idate', .... It means we forget a db->escape when forging sql request.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/(\$sql|SET\s|WHERE\s|INSERT\s|VALUES\s|VALUES\().+\s*\'\s*\.\s*\$(.........)/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if (! in_array($val[2], array('this->db-', 'db->prefi', 'db->sanit', 'dbs->pref', 'dbs->sani', 'conf->ent', 'key : \'\')', 'key])."\')', 'excludefi', 'regexstri', ''))) {
|
|
||||||
$ok = false;
|
|
||||||
var_dump($matches);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non escaped string in building of a sql request (case 3) in '.$file['relativename'].': '.$val[0].' - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Checks with IN
|
|
||||||
|
|
||||||
// Check string ' IN (".xxx' or ' IN (\'.xxx' with xxx that is not '$this->db->sanitize' and not '$db->sanitize'. It means we forget a db->sanitize when forging sql request.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/\s+IN\s*\([\'"]\s*\.\s*(.........)/i', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
//var_dump($val);
|
|
||||||
if (!in_array($val[1], array('$db->sani', '$this->db', 'getEntity', 'WON\',\'L', 'self::STA', 'Commande:', 'CommandeF', 'Entrepot:', 'Facture::', 'FactureFo', 'ExpenseRe', 'Societe::', 'Ticket::S'))) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non sanitized string in building of a IN or NOT IN sql request '.$file['relativename'].' - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Check string ' IN (\'".xxx' with xxx that is not '$this->db->sanitize' and not '$db->sanitize'. It means we forget a db->sanitize when forging sql request.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/\s+IN\s*\(\'"\s*\.\s*(.........)/i', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
//var_dump($val);
|
|
||||||
if (!in_array($val[1], array('$db->sani', '$this->db', 'getEntity', 'WON\',\'L', 'self::STA', 'Commande:', 'CommandeF', 'Entrepot:', 'Facture::', 'FactureFo', 'ExpenseRe', 'Societe::', 'Ticket::S'))) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found non sanitized string in building of a IN or NOT IN sql request '.$file['relativename'].' - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
// Test that output of $_SERVER\[\'QUERY_STRING\'\] is escaped.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/(..............)\$_SERVER\[\'QUERY_STRING\'\]/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if ($val[1] != 'scape_htmltag(' && $val[1] != 'ing_nohtmltag(' && $val[1] != 'dol_escape_js(') {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a $_SERVER[\'QUERY_STRING\'] without dol_escape_htmltag neither dol_string_nohtmltag around it, in file '.$file['relativename'].'. Bad.');
|
|
||||||
|
|
||||||
|
|
||||||
// Check GETPOST(... 'none');
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/GETPOST\s*\(([^\)]+),\s*["\']none["\']/i', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
//var_dump($val);
|
|
||||||
if (!in_array($val[1], array(
|
|
||||||
"'replacestring'", "'htmlheader'", "'WEBSITE_HTML_HEADER'", "'WEBSITE_CSS_INLINE'", "'WEBSITE_JS_INLINE'", "'WEBSITE_MANIFEST_JSON'", "'PAGE_CONTENT'", "'WEBSITE_README'", "'WEBSITE_LICENSE'",
|
|
||||||
'"mysqldump"', '"postgresqldump"',
|
|
||||||
"'db_pass_root'", "'db_pass'", '"pass"', '"pass1"', '"pass2"', '"password"', "'password'",
|
|
||||||
'"MAIN_MAIL_SMTPS_PW"', '"MAIN_MAIL_SMTPS_PW_EMAILING"', '"MAIN_MAIL_SMTPS_PW_TICKET"'))) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
//if ($reg[0] != 'db') $ok=false;
|
|
||||||
}
|
|
||||||
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
|
||||||
$this->assertTrue($ok, 'Found a GETPOST that use \'none\' as a parameter in file '.$file['relativename'].' and param is not an allowed parameter for using none - Bad.');
|
|
||||||
//exit;
|
|
||||||
|
|
||||||
|
|
||||||
// Test that first param of print_liste_field_titre is a translation key and not the translated value
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
// Check string ='print_liste_field_titre\(\$langs'.
|
|
||||||
preg_match_all('/print_liste_field_titre\(\$langs/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a use of print_liste_field_titre with first parameter that is a translated value instead of just the translation key in file '.$file['relativename'].'. Bad.');
|
|
||||||
|
|
||||||
|
|
||||||
// Test we don't have <br />
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/<br\s+\/>/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if ($file['name'] != 'functions.lib.php') {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a tag <br /> that is for xml in file '.$file['relativename'].'. You must use html syntax <br> instead.');
|
|
||||||
|
|
||||||
|
|
||||||
// Test we don't have name="token" value="'.$_SESSION['newtoken'], we must use name="token" value="'.newToken() instead.
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/name="token" value="\'\s*\.\s*\$_SESSION/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if ($file['name'] != 'excludefile.php') {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a forbidden string sequence into '.$file['relativename'].' : name="token" value="\'.$_SESSION[..., you must use a newToken() instead of $_SESSION[\'newtoken\'].');
|
|
||||||
|
|
||||||
|
|
||||||
// Test we don't have preg_grep with a param without preg_quote
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/preg_grep\(.*\$/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
if (strpos($val[0], 'preg_quote') === false) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a preg_grep with a param that is a $var but without preg_quote in file '.$file['relativename'].'.');
|
|
||||||
|
|
||||||
|
|
||||||
// Test we don't have "if ($resql >"
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/if \(\$resql >/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a if $resql with a > operator (when $resql is a boolean or resource) in file '.$file['relativename'].'. Please remove the > ... part.');
|
|
||||||
|
|
||||||
// Test we don't have empty($user->hasRight
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/empty\(\$user->hasRight/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found code empty($user->hasRight in file '.$file['relativename'].'. empty() must not be used on a var not on a function.');
|
|
||||||
|
|
||||||
// Test we don't have empty(DolibarrApiAccess::$user->hasRight
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/empty\(DolibarrApiAccess::\$user->hasRight/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found code empty(DolibarrApiAccess::$user->hasRight in file '.$file['relativename'].'. empty() must not be used on a var not on a function.');
|
|
||||||
|
|
||||||
// Test we don't have empty($user->hasRight
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/empty\(getDolGlobal/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found code empty(getDolGlobal... in file '.$file['relativename'].'. empty() must be used on a var not on a function.');
|
|
||||||
|
|
||||||
// Test we don't have @var array(
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/@var\s+array\(/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a declaration @var array() instead of @var array in file '.$file['relativename'].'.');
|
|
||||||
|
|
||||||
|
|
||||||
// Test we don't have CURDATE()
|
|
||||||
$ok = true;
|
|
||||||
$matches = array();
|
|
||||||
preg_match_all('/CURDATE\(\)/', $filecontent, $matches, PREG_SET_ORDER);
|
|
||||||
foreach ($matches as $key => $val) {
|
|
||||||
$ok = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
$this->assertTrue($ok, 'Found a CURDATE\(\) into code. Do not use this SQL method in file '.$file['relativename'].'. You must use the PHP function dol_now() instead.');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return;
|
// Check we don't miss top_httphead() into any ajax pages
|
||||||
|
if (preg_match('/ajax\//', $file['relativename'])) {
|
||||||
|
print "Analyze ajax page ".$file['relativename']."\n";
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/top_httphead/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
if (count($matches) == 0) {
|
||||||
|
$ok = false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Did not find top_httphead into the ajax page '.$file['relativename']);
|
||||||
|
//exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if a var_dump has been forgotten
|
||||||
|
if (!preg_match('/test\/phpunit/', $file['fullname'])) {
|
||||||
|
if (! in_array($file['name'], array('class.nusoap_base.php'))) {
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/(.)\s*var_dump\(/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
//var_dump($matches);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($val[1] != '/' && $val[1] != '*') {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found string var_dump that is not just after /* or // in '.$file['relativename']);
|
||||||
|
//exit;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check get_class followed by __METHOD__
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/'.preg_quote('get_class($this)."::".__METHOD__', '/').'/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found string get_class($this)."::".__METHOD__ that must be replaced with __METHOD__ only in '.$file['relativename']);
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Check string $this->db->idate without quotes
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/(..)\s*\.\s*\$this->db->idate\(/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($val[1] != '\'"' && $val[1] != '\'\'') {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found a $this->db->idate to forge a sql request without quotes around this date field '.$file['relativename']);
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Check sql string DELETE|OR|AND|WHERE|INSERT ... yyy = ".$xxx
|
||||||
|
// with xxx that is not 'thi' (for $this->db->sanitize) and 'db-' (for $db->sanitize). It means we forget a ' if string, or an (int) if int, when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/(DELETE|OR|AND|WHERE|INSERT)\s.*([^\s][^\s][^\s])\s*=\s*(\'|")\s*\.\s*\$(...)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($val[2] == 'ity' && $val[4] == 'con') { // exclude entity = ".$conf->entity
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if ($val[2] == 'ame' && $val[4] == 'db-' && preg_match('/WHERE name/', $val[0])) { // exclude name = ".$db->encrypt(
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if ($val[2] == 'ame' && $val[4] == 'thi' && preg_match('/WHERE name/', $val[0])) { // exclude name = ".$this->db->encrypt(
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
var_dump($matches);
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non quoted or not casted var into sql request '.$file['relativename'].' - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Check that forged sql string is using ' instead of " as string PHP quotes
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/\$sql \.= \'\s*VALUES.*\$/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
//if ($val[1] != '\'"' && $val[1] != '\'\'') {
|
||||||
|
var_dump($matches);
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
//}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found a forged SQL string that mix on same line the use of \' for PHP string and PHP variables into file '.$file['relativename'].' Use " to forge PHP string like this: $sql = "SELECT ".$myvar...');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Check that forged sql string is using ' instead of " as string PHP quotes
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/\$sql \.?= \'SELECT.*\$/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
var_dump($matches);
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a forged SQL string that mix on same line the use of \' for PHP string and PHP variables into file '.$file['relativename'].' Use " to forge PHP string like this: $sql = "SELECT ".$myvar...');
|
||||||
|
|
||||||
|
// Check sql string VALUES ... , ".$xxx
|
||||||
|
// with xxx that is not 'db-' (for $db->escape). It means we forget a ' if string, or an (int) if int, when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/(VALUES).*,\s*"\s*\.\s*\$(...)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($val[1] == 'VALUES' && $val[2] == 'db-') { // exclude $db->escape(
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if ($val[1] == 'VALUES' && $val[2] == 'thi' && preg_match('/this->db->encrypt/', $val[0])) { // exclude ".$this->db->encrypt(
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
var_dump($matches);
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non quoted or not casted var into sql request '.$file['relativename'].' - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Check '".$xxx non escaped
|
||||||
|
|
||||||
|
// Check string ='".$this->xxx with xxx that is not 'escape'. It means we forget a db->escape when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/=\s*\'"\s*\.\s*\$this->(....)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($val[1] != 'db->' && $val[1] != 'esca') {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non escaped string in building of a sql request (case 1) in '.$file['relativename'].' - Bad.');
|
||||||
|
|
||||||
|
// Check string sql|set|WHERE|...'".$yyy->xxx with xxx that is not 'escape', 'idate', .... It means we forget a db->escape when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
$found = "";
|
||||||
|
preg_match_all('/(sql|SET|WHERE|INSERT|VALUES|LIKE).+\s*\'"\s*\.\s*\$(.......)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if (! in_array($val[2], array('this->d', 'this->e', 'db->esc', 'dbs->es', 'dbs->id', 'mydb->e', 'dbsessi', 'db->ida', 'escaped', 'exclude', 'include'))) {
|
||||||
|
$found = $val[0];
|
||||||
|
$ok = false; // This will generate error
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non escaped string in building of a sql request (case 2) in '.$file['relativename'].': '.$found.' - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Check string sql|set...'.$yyy->xxx with xxx that is not 'escape', 'idate', .... It means we forget a db->escape when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
$found = "";
|
||||||
|
preg_match_all('/(\$sql|SET\s|WHERE\s|INSERT\s|VALUES\s|VALUES\().+\s*\'\s*\.\s*\$(.........)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if (! in_array($val[2], array('this->db-', 'db->prefi', 'db->sanit', 'dbs->pref', 'dbs->sani', 'conf->ent', 'key : \'\')', 'key])."\')', 'excludefi', 'regexstri', ''))) {
|
||||||
|
$found = $val[0];
|
||||||
|
$ok = false;
|
||||||
|
var_dump($matches);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non escaped string in building of a sql request (case 3) in '.$file['relativename'].': '.$found.' - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Checks with IN
|
||||||
|
|
||||||
|
// Check string ' IN (".xxx' or ' IN (\'.xxx' with xxx that is not '$this->db->sanitize' and not '$db->sanitize'. It means we forget a db->sanitize when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/\s+IN\s*\([\'"]\s*\.\s*(.........)/i', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
//var_dump($val);
|
||||||
|
if (!in_array($val[1], array('$db->sani', '$this->db', 'getEntity', 'WON\',\'L', 'self::STA', 'Commande:', 'CommandeF', 'Entrepot:', 'Facture::', 'FactureFo', 'ExpenseRe', 'Societe::', 'Ticket::S'))) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non sanitized string in building of a IN or NOT IN sql request '.$file['relativename'].' - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Check string ' IN (\'".xxx' with xxx that is not '$this->db->sanitize' and not '$db->sanitize'. It means we forget a db->sanitize when forging sql request.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/\s+IN\s*\(\'"\s*\.\s*(.........)/i', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
//var_dump($val);
|
||||||
|
if (!in_array($val[1], array('$db->sani', '$this->db', 'getEntity', 'WON\',\'L', 'self::STA', 'Commande:', 'CommandeF', 'Entrepot:', 'Facture::', 'FactureFo', 'ExpenseRe', 'Societe::', 'Ticket::S'))) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found non sanitized string in building of a IN or NOT IN sql request '.$file['relativename'].' - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
// Test that output of $_SERVER\[\'QUERY_STRING\'\] is escaped.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/(..............)\$_SERVER\[\'QUERY_STRING\'\]/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($val[1] != 'scape_htmltag(' && $val[1] != 'ing_nohtmltag(' && $val[1] != 'dol_escape_js(') {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a $_SERVER[\'QUERY_STRING\'] without dol_escape_htmltag neither dol_string_nohtmltag around it, in file '.$file['relativename'].'. Bad.');
|
||||||
|
|
||||||
|
|
||||||
|
// Check GETPOST(... 'none');
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/GETPOST\s*\(([^\)]+),\s*["\']none["\']/i', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
//var_dump($val);
|
||||||
|
if (!in_array($val[1], array(
|
||||||
|
"'replacestring'", "'htmlheader'", "'WEBSITE_HTML_HEADER'", "'WEBSITE_CSS_INLINE'", "'WEBSITE_JS_INLINE'", "'WEBSITE_MANIFEST_JSON'", "'PAGE_CONTENT'", "'WEBSITE_README'", "'WEBSITE_LICENSE'",
|
||||||
|
'"mysqldump"', '"postgresqldump"',
|
||||||
|
"'db_pass_root'", "'db_pass'", '"pass"', '"pass1"', '"pass2"', '"password"', "'password'",
|
||||||
|
'"MAIN_MAIL_SMTPS_PW"', '"MAIN_MAIL_SMTPS_PW_EMAILING"', '"MAIN_MAIL_SMTPS_PW_TICKET"'))) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
//if ($reg[0] != 'db') $ok=false;
|
||||||
|
}
|
||||||
|
//print __METHOD__." Result for checking we don't have non escaped string in sql requests for file ".$file."\n";
|
||||||
|
$this->assertTrue($ok, 'Found a GETPOST that use \'none\' as a parameter in file '.$file['relativename'].' and param is not an allowed parameter for using none - Bad.');
|
||||||
|
//exit;
|
||||||
|
|
||||||
|
|
||||||
|
// Test that first param of print_liste_field_titre is a translation key and not the translated value
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
// Check string ='print_liste_field_titre\(\$langs'.
|
||||||
|
preg_match_all('/print_liste_field_titre\(\$langs/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a use of print_liste_field_titre with first parameter that is a translated value instead of just the translation key in file '.$file['relativename'].'. Bad.');
|
||||||
|
|
||||||
|
|
||||||
|
// Test we don't have <br />
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/<br\s+\/>/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($file['name'] != 'functions.lib.php') {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a tag <br /> that is for xml in file '.$file['relativename'].'. You must use html syntax <br> instead.');
|
||||||
|
|
||||||
|
|
||||||
|
// Test we don't have name="token" value="'.$_SESSION['newtoken'], we must use name="token" value="'.newToken() instead.
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/name="token" value="\'\s*\.\s*\$_SESSION/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if ($file['name'] != 'excludefile.php') {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a forbidden string sequence into '.$file['relativename'].' : name="token" value="\'.$_SESSION[..., you must use a newToken() instead of $_SESSION[\'newtoken\'].');
|
||||||
|
|
||||||
|
|
||||||
|
// Test we don't have preg_grep with a param without preg_quote
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/preg_grep\(.*\$/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
if (strpos($val[0], 'preg_quote') === false) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a preg_grep with a param that is a $var but without preg_quote in file '.$file['relativename'].'.');
|
||||||
|
|
||||||
|
|
||||||
|
// Test we don't have "if ($resql >"
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/if \(\$resql >/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a if $resql with a > operator (when $resql is a boolean or resource) in file '.$file['relativename'].'. Please remove the > ... part.');
|
||||||
|
|
||||||
|
// Test we don't have empty($user->hasRight
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/empty\(\$user->hasRight/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found code empty($user->hasRight in file '.$file['relativename'].'. empty() must not be used on a var not on a function.');
|
||||||
|
|
||||||
|
// Test we don't have empty(DolibarrApiAccess::$user->hasRight
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/empty\(DolibarrApiAccess::\$user->hasRight/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found code empty(DolibarrApiAccess::$user->hasRight in file '.$file['relativename'].'. empty() must not be used on a var not on a function.');
|
||||||
|
|
||||||
|
// Test we don't have empty($user->hasRight
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/empty\(getDolGlobal/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found code empty(getDolGlobal... in file '.$file['relativename'].'. empty() must be used on a var not on a function.');
|
||||||
|
|
||||||
|
// Test we don't have @var array(
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/@var\s+array\(/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a declaration @var array() instead of @var array in file '.$file['relativename'].'.');
|
||||||
|
|
||||||
|
|
||||||
|
// Test we don't have CURDATE()
|
||||||
|
$ok = true;
|
||||||
|
$matches = array();
|
||||||
|
preg_match_all('/CURDATE\(\)/', $filecontent, $matches, PREG_SET_ORDER);
|
||||||
|
foreach ($matches as $key => $val) {
|
||||||
|
$ok = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
$this->assertTrue($ok, 'Found a CURDATE\(\) into code. Do not use this SQL method in file '.$file['relativename'].'. You must use the PHP function dol_now() instead.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -79,7 +79,9 @@ abstract class CommonClassTest extends TestCase
|
|||||||
$this->savlangs = $langs;
|
$this->savlangs = $langs;
|
||||||
$this->savdb = $db;
|
$this->savdb = $db;
|
||||||
|
|
||||||
print __METHOD__." db->type=".$db->type." user->id=".$user->id;
|
if ((int) getenv('PHPUNIT_DEBUG') > 0) {
|
||||||
|
print get_called_class()." db->type=".$db->type." user->id=".$user->id;
|
||||||
|
}
|
||||||
//print " - db ".$db->db;
|
//print " - db ".$db->db;
|
||||||
print PHP_EOL;
|
print PHP_EOL;
|
||||||
}
|
}
|
||||||
@@ -94,13 +96,8 @@ abstract class CommonClassTest extends TestCase
|
|||||||
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.
|
||||||
|
|
||||||
if (!isModEnabled('agenda')) {
|
if ((int) getenv('PHPUNIT_DEBUG') > 0) {
|
||||||
print get_called_class()." module agenda must be enabled.".PHP_EOL;
|
print get_called_class()."::".__FUNCTION__.PHP_EOL;
|
||||||
die(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isset($_ENV['PHPUNIT_DEBUG'])) {
|
|
||||||
print get_called_class().PHP_EOL;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -126,12 +123,24 @@ abstract class CommonClassTest extends TestCase
|
|||||||
// Get the last line of the log
|
// Get the last line of the log
|
||||||
$last_lines = array_slice($lines, $first_line, $nbLinesToShow);
|
$last_lines = array_slice($lines, $first_line, $nbLinesToShow);
|
||||||
|
|
||||||
|
$failedTestMethod = $this->getName(false);
|
||||||
|
$className = get_called_class();
|
||||||
|
|
||||||
|
// Get the test method's reflection
|
||||||
|
$reflectionMethod = new ReflectionMethod($className, $failedTestMethod);
|
||||||
|
|
||||||
|
// Get the test method's data set
|
||||||
|
$argsText = $this->getDataSetAsString(true);
|
||||||
|
|
||||||
// Show log file
|
// Show log file
|
||||||
print PHP_EOL."----- Test fails. Show last ".$nbLinesToShow." lines of dolibarr.log file -----".PHP_EOL;
|
print PHP_EOL;
|
||||||
|
print "----- $className::$failedTestMethod failed - $argsText.".PHP_EOL;
|
||||||
|
print "Show last ".$nbLinesToShow." lines of dolibarr.log file -----".PHP_EOL;
|
||||||
foreach ($last_lines as $line) {
|
foreach ($last_lines as $line) {
|
||||||
print $line . "<br>";
|
print $line . "<br>";
|
||||||
}
|
}
|
||||||
print PHP_EOL;
|
print PHP_EOL;
|
||||||
|
print "----- end of dolibarr.log for $className::$failedTestMethod".PHP_EOL;
|
||||||
|
|
||||||
parent::onNotSuccessfulTest($t);
|
parent::onNotSuccessfulTest($t);
|
||||||
}
|
}
|
||||||
@@ -150,10 +159,9 @@ abstract class CommonClassTest extends TestCase
|
|||||||
$langs = $this->savlangs;
|
$langs = $this->savlangs;
|
||||||
$db = $this->savdb;
|
$db = $this->savdb;
|
||||||
|
|
||||||
if (isset($_ENV['PHPUNIT_DEBUG'])) {
|
if ((int) getenv('PHPUNIT_DEBUG') > 0) {
|
||||||
print get_called_class().PHP_EOL;
|
print get_called_class().'::'.$this->getName(false)."::".__FUNCTION__.PHP_EOL;
|
||||||
}
|
}
|
||||||
print __METHOD__."\n";
|
|
||||||
//print $db->getVersion()."\n";
|
//print $db->getVersion()."\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -164,8 +172,8 @@ abstract class CommonClassTest extends TestCase
|
|||||||
*/
|
*/
|
||||||
protected function tearDown(): void
|
protected function tearDown(): void
|
||||||
{
|
{
|
||||||
if (isset($_ENV['PHPUNIT_DEBUG'])) {
|
if ((int) getenv('PHPUNIT_DEBUG') > 0) {
|
||||||
print get_called_class().PHP_EOL;
|
print get_called_class().'::'.$this->getName(false)."::".__FUNCTION__.PHP_EOL;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -178,8 +186,8 @@ abstract class CommonClassTest extends TestCase
|
|||||||
{
|
{
|
||||||
global $db;
|
global $db;
|
||||||
$db->rollback();
|
$db->rollback();
|
||||||
if (isset($_ENV['PHPUNIT_DEBUG'])) {
|
if ((int) getenv('PHPUNIT_DEBUG') > 0) {
|
||||||
print get_called_class().PHP_EOL;
|
print get_called_class()."::".__FUNCTION__.PHP_EOL;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user