joomla/jedchecker
33
2
Fork 0
mirror of https://github.com/joomla-extensions/jedchecker.git synced 2024-11-05 21:07:57 +00:00
Code Issues Releases Activity

Merge PR #82 with develop

Browse Source
This commit is contained in:
Llewellyn van der Merwe 2021-04-27 01:19:11 +02:00
commit bf2ca15b99
Signed by: Llewellyn
GPG Key ID: EFC0C720A240551C
2 changed files with 397 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
administrator/components/com_jedchecker/language/en-GB/en-GB.com_jedchecker.ini
View File

@ -90,6 +90,7 @@ COM_JEDCHECKER_INFO_XML_UPDATE_SERVER_LINK="The Update Server link in this XML f
COM_JEDCHECKER_DELETE_FAILED="Can't delete temporary folder"
COM_JEDCHECKER_DELETE_SUCCESS="Temporary folder deleted!"
COM_JEDCHECKER_EMPTY_UPLOAD_FIELD="Please, select a zipped file to be uploaded"
<<<<<<< HEAD
COM_JEDCHECKER_TOOLBAR_CHECK="Check"
COM_JEDCHECKER_TOOLBAR_CLEAR="Clear"
COM_JEDCHECKER_CLICK_TO_VIEW_DETAILS="Click to View Details"
@ -108,3 +109,7 @@ COM_JEDCHECKER_MANIFEST_MENU_UNUSED_ATTRIBUTE="Menu item attribute '%s' is not u
COM_JEDCHECKER_MANIFEST_MISSED_METHOD_UPGRADE="Without the method=&quot;upgrade&quot; attribute the extension package cannot be upgraded"
COM_JEDCHECKER_MANIFEST_MISSED_ATTRIBUTE="The node &lt;%1$s&gt; doesn't contain required '%2$s' attribute"
COM_JEDCHECKER_MANIFEST_UNKNOWN_ATTRIBUTE_VALUE="The node &lt;%1$s&gt; has attribute '%2$s' with unknown value &quot;%3$s&quot;"
COM_JEDCHECKER_XML_FILES="XML Files references"
COM_JEDCHECKER_XML_FILES_DESC="Check for incorrect files and folders references in the XML manifest"
COM_JEDCHECKER_XML_FILES_FILE_NOT_FOUND="File not found: %s"
COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND="Folder not found: %s"

392
administrator/components/com_jedchecker/libraries/rules/xmlfiles.php Normal file
View File

@ -0,0 +1,392 @@
<?php
/**
* @package Joomla.JEDChecker
*
* @copyright Copyright (C) 2021 Open Source Matters, Inc. All rights reserved.
*
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die('Restricted access');
// Include the rule base class
require_once JPATH_COMPONENT_ADMINISTRATOR . '/models/rule.php';
/**
* class JedcheckerRulesXMLFiles
*
* This class searches all xml manifests for valid files declarations
*
* @since 2.3
*/
class JedcheckerRulesXMLFiles extends JEDcheckerRule
{
/**
* The formal ID of this rule. For example: SE1.
*
* @var string
*/
protected $id = 'XMLFILES';
/**
* The title or caption of this rule.
*
* @var string
*/
protected $title = 'COM_JEDCHECKER_XML_FILES';
/**
* The description of this rule.
*
* @var string
*/
protected $description = 'COM_JEDCHECKER_XML_FILES_DESC';
/**
* List of errors.
*
* @var string[]
*/
protected $errors;
/**
* Initiates the search and check
*
* @return void
*/
public function check()
{
// Find all XML files of the extension
$files = JFolder::files($this->basedir, '\.xml$', true, true);
// Iterate through all the xml files
foreach ($files as $file)
{
// Try to check the file
$this->find($file);
}
}
/**
* Reads a file and validate XML manifest
*
* @param string $file - The path to the file
*
* @return boolean True if the manifest file was found, otherwise False.
*/
protected function find($file)
{
$xml = simplexml_load_file($file);
// Failed to parse the xml file.
// Assume that this is not a extension manifest
if (!$xml)
{
return false;
}
// Check if this is an extension manifest
if ($xml->getName() !== 'extension')
{
return false;
}
$this->errors = array();
// Check declared files and folders do exist
$basedir = dirname($file) . '/';
$sitedir = $basedir;
// Check: files[folder] (filename|folder)*
// ( for package: files[folder] (file|folder)* )
if (isset($xml->files))
{
$node = $xml->files;
// Get path to site files from "folder" attribute
$sitedir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $sitedir);
$this->checkFiles($node->file, $sitedir);
$this->checkFolders($node->folder, $sitedir);
}
// Check: media[folder] (filename|file|folder)*
if (isset($xml->media))
{
$node = $xml->media;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir);
$this->checkFolders($node->folder, $dir);
}
// Check: fonts[folder] (filename|file|folder)*
if (isset($xml->fonts))
{
$node = $xml->fonts;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir);
$this->checkFolders($node->folder, $dir);
}
// Check files: languages[folder] language*
if (isset($xml->languages))
{
$node = $xml->languages;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->language, $dir);
}
$admindir = $basedir;
// Check: administration files[folder] (filename|file|folder)*
if (isset($xml->administration->files))
{
$node = $xml->administration->files;
// Get path to admin files from "folder" attribute
$admindir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $admindir);
$this->checkFiles($node->file, $admindir);
$this->checkFolders($node->folder, $admindir);
}
// Check: administration media[folder] (filename|file|folder)*
if (isset($xml->administration->media))
{
$node = $xml->administration->media;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir);
$this->checkFolders($node->folder, $dir);
}
// Check files: administration languages[folder] language*
if (isset($xml->administration->languages))
{
$node = $xml->administration->languages;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->language, $dir);
}
// For type="file" extensions:
// Check files: fileset files[folder] (filename|file|folder)*
if (isset($xml->fileset->files))
{
$node = $xml->fileset->files;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $dir);
$this->checkFiles($node->file, $dir);
$this->checkFolders($node->folder, $dir);
}
// Check file: scriptfile
if (isset($xml->scriptfile))
{
$this->checkFiles($xml->scriptfile, $basedir);
}
// Check files: install sql file*
if (isset($xml->install->sql->file))
{
$this->checkFiles($xml->install->sql->file, $admindir);
}
// Check files: uninstall sql file*
if (isset($xml->uninstall->sql->file))
{
$this->checkFiles($xml->uninstall->sql->file, $admindir);
}
// Check folders: update schemas schemapath*
if (isset($xml->update->schemas->schemapath))
{
$this->checkFolders($xml->update->schemas->schemapath, $admindir);
}
// Check: config [add...path] directories exist
if (isset($xml->config))
{
$attributes = array('addfieldpath', 'addformpath', 'addrulepath');
$extensionPath = false;
// @TODO move element name extraction into a helper (similar code is used in XMLinfo rule)
switch ((string) $xml['type'])
{
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 . '/';
break;
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'];
$extensionPath = 'plugins/' . $group . '/' . $element . '/';
break;
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 . '/';
}
if ($extensionPath !== false)
{
foreach ($attributes as $attribute)
{
foreach ($xml->config->xpath('//*[@' . $attribute . ']') as $node)
{
$attrPath = (string) $node[$attribute];
$folder = ltrim($attrPath, '/');
// Convert absolute path to relative (if matches extension path)
if (strpos($folder, $extensionPath) === 0)
{
$folder = $sitedir . substr($folder, strlen($extensionPath));
if (!is_dir($folder))
{
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', $attrPath);
}
}
}
}
}
}
// Check /namespace[path] directory exists (Joomla!4)
if (isset($xml->namespace['path']))
{
$folder = (string) $xml->namespace['path'];
if (!is_dir($admindir . $folder) && !is_dir($sitedir . $folder))
{
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', $folder);
}
}
if (count($this->errors))
{
$this->report->addError($file, implode('<br />', $this->errors));
}
// All checks passed. Return true
return true;
}
/**
* Check files exist
*
* @param SimpleXMLElement $files Files to check
* @param string $dir Base directory
*
* @return void
*/
protected function checkFiles($files, $dir)
{
foreach ($files as $file)
{
$filename = $dir . $file;
if (is_file($filename))
{
continue;
}
// Extra check for unzipped files
if (preg_match('/^(.*)\.(zip|tgz|tar\.gz)$/', $filename, $matches) && is_dir($matches[1]))
{
continue;
}
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FILE_NOT_FOUND', (string) $file);
}
}
/**
* Check folders exist
*
* @param SimpleXMLElement $folders Directories to check
* @param string $dir Base directory
*
* @return void
*/
protected function checkFolders($folders, $dir)
{
foreach ($folders as $folder)
{
if (!is_dir($dir . $folder))
{
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FOLDER_NOT_FOUND', (string) $folder);
}
}
}
}