31
2
mirror of https://github.com/joomla-extensions/jedchecker.git synced 2024-09-27 20:49:05 +00:00

Merge PR #121 with develop

This commit is contained in:
Llewellyn van der Merwe 2021-06-09 16:15:29 +02:00
commit 506cf8b85b
Signed by: Llewellyn
GPG Key ID: EFC0C720A240551C

View File

@ -13,6 +13,9 @@ defined('_JEXEC') or die('Restricted access');
// Include the rule base class // Include the rule base class
require_once JPATH_COMPONENT_ADMINISTRATOR . '/models/rule.php'; require_once JPATH_COMPONENT_ADMINISTRATOR . '/models/rule.php';
// Include the helper class
require_once JPATH_COMPONENT_ADMINISTRATOR . '/libraries/helper.php';
/** /**
* class JedcheckerRulesXMLFiles * class JedcheckerRulesXMLFiles
@ -51,6 +54,13 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
*/ */
protected $errors; protected $errors;
/**
* Manifest's directory
*
* @var string
*/
protected $basedir;
/** /**
* Initiates the search and check * Initiates the search and check
* *
@ -59,7 +69,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
public function check() public function check()
{ {
// Find all XML files of the extension // Find all XML files of the extension
$files = JFolder::files($this->basedir, '\.xml$', true, true); $files = JEDCheckerHelper::findManifests($this->basedir);
// Iterate through all the xml files // Iterate through all the xml files
foreach ($files as $file) foreach ($files as $file)
@ -87,19 +97,13 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
return false; return false;
} }
// Check if this is an extension manifest
if ($xml->getName() !== 'extension')
{
return false;
}
$this->errors = array(); $this->errors = array();
// Check declared files and folders do exist // Check declared files and folders do exist
$basedir = dirname($file) . '/'; $this->basedir = dirname($file) . '/';
$sitedir = $basedir; $sitedir = '';
// Check: files[folder] (filename|folder)* // Check: files[folder] (filename|folder)*
// ( for package: files[folder] (file|folder)* ) // ( for package: files[folder] (file|folder)* )
@ -108,7 +112,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
$node = $xml->files; $node = $xml->files;
// Get path to site files from "folder" attribute // Get path to site files from "folder" attribute
$sitedir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $sitedir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->filename, $sitedir); $this->checkFiles($node->filename, $sitedir);
$this->checkFiles($node->file, $sitedir); $this->checkFiles($node->file, $sitedir);
@ -119,7 +123,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
if (isset($xml->media)) if (isset($xml->media))
{ {
$node = $xml->media; $node = $xml->media;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $dir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->filename, $dir); $this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir); $this->checkFiles($node->file, $dir);
@ -130,7 +134,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
if (isset($xml->fonts)) if (isset($xml->fonts))
{ {
$node = $xml->fonts; $node = $xml->fonts;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $dir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->filename, $dir); $this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir); $this->checkFiles($node->file, $dir);
@ -141,12 +145,12 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
if (isset($xml->languages)) if (isset($xml->languages))
{ {
$node = $xml->languages; $node = $xml->languages;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $dir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->language, $dir); $this->checkFiles($node->language, $dir);
} }
$admindir = $basedir; $admindir = '';
// Check: administration files[folder] (filename|file|folder)* // Check: administration files[folder] (filename|file|folder)*
if (isset($xml->administration->files)) if (isset($xml->administration->files))
@ -154,7 +158,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
$node = $xml->administration->files; $node = $xml->administration->files;
// Get path to admin files from "folder" attribute // Get path to admin files from "folder" attribute
$admindir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $admindir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->filename, $admindir); $this->checkFiles($node->filename, $admindir);
$this->checkFiles($node->file, $admindir); $this->checkFiles($node->file, $admindir);
@ -165,7 +169,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
if (isset($xml->administration->media)) if (isset($xml->administration->media))
{ {
$node = $xml->administration->media; $node = $xml->administration->media;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $dir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->filename, $dir); $this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir); $this->checkFiles($node->file, $dir);
@ -176,7 +180,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
if (isset($xml->administration->languages)) if (isset($xml->administration->languages))
{ {
$node = $xml->administration->languages; $node = $xml->administration->languages;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $dir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->language, $dir); $this->checkFiles($node->language, $dir);
} }
@ -186,7 +190,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
if (isset($xml->fileset->files)) if (isset($xml->fileset->files))
{ {
$node = $xml->fileset->files; $node = $xml->fileset->files;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : ''); $dir = isset($node['folder']) ? $node['folder'] . '/' : '';
$this->checkFiles($node->filename, $dir); $this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir); $this->checkFiles($node->file, $dir);
@ -196,7 +200,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
// Check file: scriptfile // Check file: scriptfile
if (isset($xml->scriptfile)) if (isset($xml->scriptfile))
{ {
$this->checkFiles($xml->scriptfile, $basedir); $this->checkFiles($xml->scriptfile);
} }
// Check files: install sql file* // Check files: install sql file*
@ -222,79 +226,23 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
{ {
$attributes = array('addfieldpath', 'addformpath', 'addrulepath'); $attributes = array('addfieldpath', 'addformpath', 'addrulepath');
$element = JEDCheckerHelper::getElementName($xml);
$extensionPath = false; $extensionPath = false;
// @TODO move element name extraction into a helper (similar code is used in XMLinfo rule) $type = (string) $xml['type'];
switch ((string) $xml['type'])
switch ($type)
{ {
case 'module': case 'module':
if (isset($xml->element))
{
$element = (string) $xml->element;
}
else
{
$element = (string) $xml->name;
if (isset($xml->files))
{
foreach ($xml->files->children() as $child)
{
if (isset($child['module']))
{
$element = (string) $child['module'];
break;
}
}
}
}
$element = strtolower(JFilterInput::getInstance()->clean($element, 'cmd'));
$extensionPath = 'modules/' . $element . '/'; $extensionPath = 'modules/' . $element . '/';
break; break;
case 'plugin': case 'plugin':
if (isset($xml->element))
{
$element = (string) $xml->element;
}
else
{
$element = (string) $xml->name;
if (isset($xml->files))
{
foreach ($xml->files->children() as $child)
{
if (isset($child['plugin']))
{
$element = (string) $child['plugin'];
break;
}
}
}
}
$element = strtolower(JFilterInput::getInstance()->clean($element, 'cmd'));
$group = (string) $xml['group']; $group = (string) $xml['group'];
$extensionPath = 'plugins/' . $group . '/' . $element . '/'; $extensionPath = 'plugins/' . $group . '/' . $element . '/';
break; break;
case 'template': case 'template':
if (isset($xml->element))
{
$element = (string) $xml->element;
}
else
{
$element = (string) $xml->name;
}
$element = strtolower(JFilterInput::getInstance()->clean($element, 'cmd'));
$extensionPath = 'templates/' . $element . '/'; $extensionPath = 'templates/' . $element . '/';
} }
@ -310,7 +258,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
// Convert absolute path to relative (if matches extension path) // Convert absolute path to relative (if matches extension path)
if (strpos($folder, $extensionPath) === 0) if (strpos($folder, $extensionPath) === 0)
{ {
$folder = $sitedir . substr($folder, strlen($extensionPath)); $folder = $this->basedir . $sitedir . substr($folder, strlen($extensionPath));
if (!is_dir($folder)) if (!is_dir($folder))
{ {
@ -327,7 +275,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
{ {
$folder = (string) $xml->namespace['path']; $folder = (string) $xml->namespace['path'];
if (!is_dir($admindir . $folder) && !is_dir($sitedir . $folder)) if (!is_dir($this->basedir . $admindir . $folder) && !is_dir($this->basedir . $sitedir . $folder))
{ {
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', $folder); $this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', $folder);
} }
@ -350,11 +298,11 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
* *
* @return void * @return void
*/ */
protected function checkFiles($files, $dir) protected function checkFiles($files, $dir = '')
{ {
foreach ($files as $file) foreach ($files as $file)
{ {
$filename = $dir . $file; $filename = $this->basedir . $dir . $file;
if (is_file($filename)) if (is_file($filename))
{ {
@ -367,7 +315,7 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
continue; continue;
} }
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FILE_NOT_FOUND', (string) $file); $this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FILE_NOT_FOUND', $dir . $file);
} }
} }
@ -379,13 +327,13 @@ class JedcheckerRulesXMLFiles extends JEDcheckerRule
* *
* @return void * @return void
*/ */
protected function checkFolders($folders, $dir) protected function checkFolders($folders, $dir = '')
{ {
foreach ($folders as $folder) foreach ($folders as $folder)
{ {
if (!is_dir($dir . $folder)) if (!is_dir($this->basedir . $dir . $folder))
{ {
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', (string) $folder); $this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', $dir . $folder);
} }
} }
} }