Skip to content

Commit c0c9ea9

Browse files
odain-cbdodain-cbd
committed
N°4789 - Parse datamodel module.xxx.php files instead of interpreting them (#746) - namespacing ModuleFileReader classes
1 parent fae2bcc commit c0c9ea9

File tree

13 files changed

+63
-29
lines changed

13 files changed

+63
-29
lines changed

‎lib/autoload.php‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414
echo $err;
1515
}
1616
}
17-
throw new RuntimeException($err);
17+
trigger_error(
18+
$err,
19+
E_USER_ERROR
20+
);
1821
}
1922

2023
require_once __DIR__ . '/composer/autoload_real.php';

‎lib/composer/autoload_psr4.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
'Psr\\Cache\\' => array($vendorDir . '/psr/cache/src'),
5656
'PhpParser\\' => array($vendorDir . '/nikic/php-parser/lib/PhpParser'),
5757
'Pelago\\Emogrifier\\' => array($vendorDir . '/pelago/emogrifier/src'),
58-
'League\\OAuth2\\Client\\' => array($vendorDir . '/league/oauth2-google/src', $vendorDir . '/league/oauth2-client/src'),
58+
'League\\OAuth2\\Client\\' => array($vendorDir . '/league/oauth2-client/src', $vendorDir . '/league/oauth2-google/src'),
5959
'Laminas\\Validator\\' => array($vendorDir . '/laminas/laminas-validator/src'),
6060
'Laminas\\Stdlib\\' => array($vendorDir . '/laminas/laminas-stdlib/src'),
6161
'Laminas\\ServiceManager\\' => array($vendorDir . '/laminas/laminas-servicemanager/src'),

‎lib/composer/autoload_static.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,8 +311,8 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
311311
),
312312
'League\\OAuth2\\Client\\' =>
313313
array (
314-
0 => __DIR__ . '/..' . '/league/oauth2-google/src',
315-
1 => __DIR__ . '/..' . '/league/oauth2-client/src',
314+
0 => __DIR__ . '/..' . '/league/oauth2-client/src',
315+
1 => __DIR__ . '/..' . '/league/oauth2-google/src',
316316
),
317317
'Laminas\\Validator\\' =>
318318
array (

‎lib/composer/platform_check.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@
3636
echo 'Composer detected issues in your platform:' . PHP_EOL.PHP_EOL . str_replace('You are running '.PHP_VERSION.'.', '', implode(PHP_EOL, $issues)) . PHP_EOL.PHP_EOL;
3737
}
3838
}
39-
throw new \RuntimeException(
40-
'Composer detected issues in your platform: ' . implode(' ', $issues)
39+
trigger_error(
40+
'Composer detected issues in your platform: ' . implode(' ', $issues),
41+
E_USER_ERROR
4142
);
4243
}

‎setup/extensionsmap.class.inc.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
<?php
2+
3+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReader;
4+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReaderException;
5+
26
require_once(APPROOT.'/setup/parameters.class.inc.php');
37
require_once(APPROOT.'/core/cmdbsource.class.inc.php');
48
require_once(APPROOT.'/setup/modulediscovery.class.inc.php');

‎setup/modulediscovery.class.inc.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
*/
2121

2222
use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator;
23+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReader;
24+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReaderException;
2325

2426
require_once(APPROOT.'setup/modulediscovery/ModuleFileReader.php');
2527

‎setup/modulediscovery/ModuleFileReader.php‎

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
<?php
22

3+
namespace Combodo\iTop\Setup\ModuleDiscovery;
4+
35
use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator;
6+
use CoreException;
7+
use Exception;
8+
use ParseError;
9+
use PhpParser\Error;
10+
use PhpParser\Node\Expr\StaticCall;
11+
use PhpParser\Node\Stmt\Expression;
12+
use PhpParser\Node\Stmt\If_;
13+
use PhpParser\ParserFactory;
14+
use PhpParser\Node\Expr\Assign;
15+
use \PhpParser\Node\Stmt\ElseIf_;
16+
use PhpParser\Node\Expr\Array_;
17+
use PhpParser\Node\Scalar\String_;
18+
use PhpParser\Node\Arg;
419

520
require_once __DIR__ . '/ModuleFileReaderException.php';
621
require_once APPROOT . 'sources/PhpParser/Evaluation/PhpExpressionEvaluator.php';
@@ -47,24 +62,24 @@ public function ReadModuleFileInformation(string $sModuleFilePath) : array
4762
{
4863
try
4964
{
50-
$oParser = (new \PhpParser\ParserFactory())->createForNewestSupportedVersion();
65+
$oParser = (new ParserFactory())->createForNewestSupportedVersion();
5166
$aNodes = $oParser->parse(file_get_contents($sModuleFilePath));
5267
}
53-
catch (PhpParser\Error $e) {
54-
throw new \ModuleFileReaderException($e->getMessage(), 0, $e, $sModuleFilePath);
68+
catch (Error $e) {
69+
throw new ModuleFileReaderException($e->getMessage(), 0, $e, $sModuleFilePath);
5570
}
5671

5772
try {
5873
foreach ($aNodes as $sKey => $oNode) {
59-
if ($oNode instanceof \PhpParser\Node\Stmt\Expression) {
74+
if ($oNode instanceof Expression) {
6075
$aModuleInfo = $this->GetModuleInformationFromAddModuleCall($sModuleFilePath, $oNode);
6176
if (! is_null($aModuleInfo)){
6277
$this->CompleteModuleInfoWithFilePath($aModuleInfo);
6378
return $aModuleInfo;
6479
}
6580
}
6681

67-
if ($oNode instanceof PhpParser\Node\Stmt\If_) {
82+
if ($oNode instanceof If_) {
6883
$aModuleInfo = $this->GetModuleInformationFromIf($sModuleFilePath, $oNode);
6984
if (! is_null($aModuleInfo)){
7085
$this->CompleteModuleInfoWithFilePath($aModuleInfo);
@@ -186,17 +201,17 @@ public function GetAndCheckModuleInstallerClass($aModuleInfo) : ?string
186201
* @param \PhpParser\Node\Expr\Assign $oAssignation
187202
*
188203
* @return array|null
189-
* @throws \ModuleFileReaderException
204+
* @throws ModuleFileReaderException
190205
*/
191206
private function GetModuleInformationFromAddModuleCall(string $sModuleFilePath, \PhpParser\Node\Stmt\Expression $oExpression) : ?array
192207
{
193208
/** @var Assign $oAssignation */
194209
$oAssignation = $oExpression->expr;
195-
if (false === ($oAssignation instanceof PhpParser\Node\Expr\StaticCall)) {
210+
if (false === ($oAssignation instanceof StaticCall)) {
196211
return null;
197212
}
198213

199-
/** @var PhpParser\Node\Expr\StaticCall $oAssignation */
214+
/** @var StaticCall $oAssignation */
200215

201216
if ("SetupWebPage" !== $oAssignation?->class?->name) {
202217
return null;
@@ -212,24 +227,24 @@ private function GetModuleInformationFromAddModuleCall(string $sModuleFilePath,
212227
}
213228

214229
$oModuleId = $aArgs[1];
215-
if (false === ($oModuleId instanceof PhpParser\Node\Arg)) {
230+
if (false === ($oModuleId instanceof Arg)) {
216231
throw new ModuleFileReaderException("2nd parameter to SetupWebPage::AddModule call issue: " . get_class($oModuleId), 0, null, $sModuleFilePath);
217232
}
218233

219-
/** @var PhpParser\Node\Arg $oModuleId */
220-
if (false === ($oModuleId->value instanceof PhpParser\Node\Scalar\String_)) {
234+
/** @var Arg $oModuleId */
235+
if (false === ($oModuleId->value instanceof String_)) {
221236
throw new ModuleFileReaderException("2nd parameter to SetupWebPage::AddModule not a string: " . get_class($oModuleId->value), 0, null, $sModuleFilePath);
222237
}
223238

224239
$sModuleId = $this->oPhpExpressionEvaluator->EvaluateExpression($oModuleId->value);
225240

226241
$oModuleConfigInfo = $aArgs[2];
227-
if (false === ($oModuleConfigInfo instanceof PhpParser\Node\Arg)) {
242+
if (false === ($oModuleConfigInfo instanceof Arg)) {
228243
throw new ModuleFileReaderException("3rd parameter to SetupWebPage::AddModule call issue: " . get_class($oModuleConfigInfo), 0, null, $sModuleFilePath);
229244
}
230245

231-
/** @var PhpParser\Node\Arg $oModuleConfigInfo */
232-
if (false === ($oModuleConfigInfo->value instanceof PhpParser\Node\Expr\Array_)) {
246+
/** @var Arg $oModuleConfigInfo */
247+
if (false === ($oModuleConfigInfo->value instanceof Array_)) {
233248
throw new ModuleFileReaderException("3rd parameter to SetupWebPage::AddModule not an array: " . get_class($oModuleConfigInfo->value), 0, null, $sModuleFilePath);
234249
}
235250

@@ -251,14 +266,14 @@ private function GetModuleInformationFromAddModuleCall(string $sModuleFilePath,
251266
* @param \PhpParser\Node\Stmt\If_ $oNode
252267
*
253268
* @return array|null
254-
* @throws \ModuleFileReaderException
269+
* @throws ModuleFileReaderException
255270
*/
256271
private function GetModuleInformationFromIf(string $sModuleFilePath, \PhpParser\Node\Stmt\If_ $oNode) : ?array
257272
{
258273
$bCondition = $this->oPhpExpressionEvaluator->EvaluateExpression($oNode->cond);
259274
if ($bCondition) {
260275
foreach ($oNode->stmts as $oSubNode) {
261-
if ($oSubNode instanceof \PhpParser\Node\Stmt\Expression) {
276+
if ($oSubNode instanceof Expression) {
262277
$aModuleConfig = $this->GetModuleInformationFromAddModuleCall($sModuleFilePath, $oSubNode);
263278
if (!is_null($aModuleConfig)) {
264279
return $aModuleConfig;
@@ -271,7 +286,7 @@ private function GetModuleInformationFromIf(string $sModuleFilePath, \PhpParser\
271286

272287
if (! is_null($oNode->elseifs)) {
273288
foreach ($oNode->elseifs as $oElseIfSubNode) {
274-
/** @var \PhpParser\Node\Stmt\ElseIf_ $oElseIfSubNode */
289+
/** @var ElseIf_ $oElseIfSubNode */
275290
$bCondition = $this->oPhpExpressionEvaluator->EvaluateExpression($oElseIfSubNode->cond);
276291
if ($bCondition) {
277292
return $this->GetModuleConfigurationFromStatement($sModuleFilePath, $oElseIfSubNode->stmts);
@@ -289,7 +304,7 @@ private function GetModuleInformationFromIf(string $sModuleFilePath, \PhpParser\
289304
private function GetModuleConfigurationFromStatement(string $sModuleFilePath, array $aStmts) : ?array
290305
{
291306
foreach ($aStmts as $oSubNode) {
292-
if ($oSubNode instanceof \PhpParser\Node\Stmt\Expression) {
307+
if ($oSubNode instanceof Expression) {
293308
$aModuleConfig = $this->GetModuleInformationFromAddModuleCall($sModuleFilePath, $oSubNode);
294309
if (!is_null($aModuleConfig)) {
295310
return $aModuleConfig;

‎setup/modulediscovery/ModuleFileReaderException.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
<?php
22

3+
namespace Combodo\iTop\Setup\ModuleDiscovery;
4+
use Exception;
5+
use SetupLog;
6+
37
class ModuleFileReaderException extends Exception
48
{
59
/**
@@ -11,7 +15,7 @@ class ModuleFileReaderException extends Exception
1115
*/
1216
public function __construct($sMessage, $iHttpCode = 0, Exception $oPrevious = null, $sModuleFile = null)
1317
{
14-
$e = new \Exception("");
18+
$e = new Exception("");
1519

1620
$aContext = ['previous' => $oPrevious?->getMessage(), 'stack' => $e->getTraceAsString()];
1721
if (!is_null($sModuleFile)) {

‎setup/runtimeenv.class.inc.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
*/
2626

2727
use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator;
28+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReader;
29+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReaderException;
2830

2931
require_once APPROOT."setup/modulediscovery.class.inc.php";
3032
require_once APPROOT.'setup/modelfactory.class.inc.php';

‎setup/unattended-install/InstallationFileService.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<?php
22

33
use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator;
4+
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReaderException;
45

56
require_once(APPROOT.'/application/utils.inc.php');
67
require_once(APPROOT.'/setup/setuppage.class.inc.php');

0 commit comments

Comments
 (0)