joomla/jedchecker
33
2
Fork 0
mirror of https://github.com/joomla-extensions/jedchecker.git synced 2024-11-27 23:36:38 +00:00
Code Issues Releases Activity

Add check for incorrect file/folder references in the XML manifest

Browse Source
This commit is contained in:
Denis Ryabov 2021-02-02 19:09:20 +03:00
parent 2ef0233058
commit 8e0d738131
2 changed files with 233 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -78,3 +78,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"
COM_JEDCHECKER_XML_FILES="Check files/folders 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"

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

@ -0,0 +1,228 @@
<?php
/**
* @package Joomla.JEDChecker
*
* @copyright Copyright (C) 2017 - 2021 Open Source Matters, Inc. All rights reserved.
* Copyright (C) 2008 - 2016 compojoom.com . All rights reserved.
* @author Daniel Dimitrov <daniel@compojoom.com>
* eaxs <support@projectfork.net>
* Denis Ryabov <denis@mobilejoomla.com>
*
* @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 manifestes 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 = JFactory::getXml($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) . '/';
// check: files[folder] (filename|folder)*
if (isset($xml->files))
{
$node = $xml->files;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $dir);
$this->checkFolders($node->folder, $dir);
}
// check: media[folder] (filename|folder)*
if (isset($xml->media))
{
$node = $xml->media;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $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);
}
// check: administration files[folder] (filename|folder)*
if (isset($xml->administration->files))
{
$node = $xml->administration->files;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $dir);
$this->checkFolders($node->folder, $dir);
}
// check: administration media[folder] (filename|folder)*
if (isset($xml->administration->media))
{
$node = $xml->administration->media;
$dir = $basedir . (isset($node['folder']) ? $node['folder'] . '/' : '');
$this->checkFiles($node->filename, $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);
}
// 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, $basedir);
}
// check files: uninstall sql file*
if (isset($xml->uninstall->sql->file))
{
$this->checkFiles($xml->uninstall->sql->file, $basedir);
}
// check folders: update schemas schemapath*
if (isset($xml->update->schemas->schemapath))
{
$this->checkFolders($xml->update->schemas->schemapath, $basedir);
}
if (count($this->errors))
{
$this->report->addError($file, implode('<br />', $this->errors));
}
// All checks passed. Return true
return true;
}
/**
* Check files exist
*
* @param JXMLElement $files Files to check
* @param string $dir Base directory
*
* @return void
*/
protected function checkFiles($files, $dir)
{
foreach ($files as $file)
{
if (!is_file($dir . $file))
{
$this->errors[] = JText::sprintf('COM_JEDCHECKER_XML_FILES_FILE_NOT_FOUND', (string)$file);
}
}
}
/**
* Check folders exist
*
* @param JXMLElement $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);
}
}
}
}