joomla/jedchecker
33
2
Fork 0
mirror of https://github.com/joomla-extensions/jedchecker.git synced 2024-11-30 16:53:59 +00:00
Code Issues Releases Activity

- fixed loading of language file

Browse Source 
- check manifest file do exist
- check naming rules
- drop Joomla!1.5 support ("install" root element)
This commit is contained in:
Denis Ryabov 2021-02-02 14:56:56 +03:00
parent 2ef0233058
commit 372ea55ad7
2 changed files with 143 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -43,6 +43,15 @@ COM_JEDCHECKER_INFO_XML_DESC="The install name of your extension must match your
COM_JEDCHECKER_INFO_XML_NAME_XML="The name tag in this file is: <b>%s</b>"
COM_JEDCHECKER_INFO_XML_VERSION_XML="Version tag has the value: %s"
COM_JEDCHECKER_INFO_XML_CREATIONDATE_XML="The creationDate tag has the value: %s"
COM_JEDCHECKER_INFO_XML_NO_MANIFEST="No manifest file found"
COM_JEDCHECKER_INFO_XML_NAME_MODULE_PLUGIN="Listing name contains 'module' or 'plugin'"
COM_JEDCHECKER_INFO_XML_NAME_RESERVED_KEYWORDS="Keywords such as module, plugin or template are considered reserved words and can't be used in the extension names"
COM_JEDCHECKER_INFO_XML_NAME_VERSION="Version in name/title"
COM_JEDCHECKER_INFO_XML_NAME_JOOMLA="An extension name can't start with the word 'Joomla'"
COM_JEDCHECKER_INFO_XML_NAME_JOOMLA_DERIVATIVE="Extensions that use 'Joomla' or a derivative of Joomla in the extension name need to be licensed by OSM"
COM_JEDCHECKER_INFO_XML_URL_JOOMLA_DERIVATIVE="Extensions that use 'Joomla' or a derivative of Joomla in the domain name need to be licensed by OSM"
COM_JEDCHECKER_INFO_XML_NAME_ADMIN_MENU="The admin menu name '%1$s' isn't the same as the extension name '%2$s'"
COM_JEDCHECKER_INFO_XML_NAME_PLUGIN_FORMAT="The name of the plugin must comply with the JED naming conventions in the form '{Type} - {Extension Name}'"
COM_JEDCHECKER_RULE_PH1="PHP Headers missing GPL License Notice"
COM_JEDCHECKER_RULE_PH1_DESC="A notice is required on each PHP file stating that the file is licensed GPL (or other compatible accepted license). For more information, please <a href='http://extensions.joomla.org/support/knowledgebase/item/jed-entries-checklists#licensechecklist' target='_blank'>click here</a>."
COM_JEDCHECKER_ERROR_GPL_NOT_FOUND="GPL or compatible license was not found"

158
administrator/components/com_jedchecker/libraries/rules/xmlinfo.php
View File

@ -57,11 +57,21 @@ class JedcheckerRulesXMLinfo extends JEDcheckerRule
// Find all XML files of the extension
$files = JFolder::files($this->basedir, '.xml$', true, true);
$manifestFound = false;
// Iterate through all the xml files
foreach ($files as $file)
{
// Try to find the license
$this->find($file);
if ($this->find($file))
{
$manifestFound = true;
}
}
if (!$manifestFound)
{
$this->report->addError('', JText::_('COM_JEDCHECKER_INFO_XML_NO_MANIFEST'));
}
}
@ -70,51 +80,151 @@ class JedcheckerRulesXMLinfo extends JEDcheckerRule
*
* @param string $file - The path to the file
*
* @return boolean True if the license was found, otherwise False.
* @return boolean True if the manifest file was found, otherwise False.
*/
protected function find($file)
{
$xml = JFactory::getXml($file);
// Get all the info about the file
$folder_info = pathinfo($file);
// Get the folder path
$folder_path = $folder_info['dirname'];
// Get the folder name
$folder_name = $folder_info['dirname'];
$folder_name_exploded = explode(DIRECTORY_SEPARATOR,$folder_name);
if ( is_array($folder_name_exploded) ) {
$folder_name = end($folder_name_exploded);
}
// Load the language of the extension (if any)
$lang = JFactory::getLanguage();
$lang->load($folder_name,$folder_path);
// Failed to parse the xml file.
// Assume that this is not a extension manifest
if (!$xml)
{
return true;
return false;
}
// Check if this is an extension manifest
// 1.5 uses 'install', 1.6 uses 'extension'
if ($xml->getName() != 'install' && $xml->getName() != 'extension')
// 1.5 uses 'install', 1.6+ uses 'extension'
if ($xml->getName() !== 'extension')
{
return true;
return false;
}
// Get extension name (element)
$type = (string) $xml['type'];
if (isset($xml->element))
{
$extension = (string) $xml->element;
}
else
{
$extension = (string) $xml->name;
foreach ($xml->files->children as $child)
{
if (isset($child[$type]))
{
$extension = (string) $child[$type];
}
}
}
$extension = strtolower(JFilterInput::getInstance()->clean($extension, 'cmd'));
if ($type === 'component' && strpos($extension, 'com_') !== 0)
{
$extension = 'com_' . $extension;
}
// Load the language of the extension (if any)
$lang = JFactory::getLanguage();
// search for .sys.ini translation file
$lang_dir = dirname($file);
$lang_tag = 'en-GB'; // $lang->getDefault();
$lookup_lang_dirs = array();
if (isset($xml->administration->files['folder']))
{
$lookup_lang_dirs[] = $xml->administration->files['folder'] . '/language/' . $lang_tag;
}
if (isset($xml->files['folder']))
{
$lookup_lang_dirs[] = $xml->files['folder'] . '/language/' . $lang_tag;
}
if (isset($xml->administration->languages['folder']))
{
$lookup_lang_dirs[] = $xml->administration->languages['folder'];
}
if (isset($xml->languages['folder']))
{
$lookup_lang_dirs[] = $xml->languages['folder'];
}
$lookup_lang_dirs[] = '';
foreach ($lookup_lang_dirs as $dir)
{
$lang_sys_file =
$lang_dir . '/' .
($dir === '' ? '' : trim($dir, '/') . '/') .
$lang_tag. '.' . $extension . '.sys.ini';
if (is_file($lang_sys_file))
{
$loadLanguage = new ReflectionMethod($lang, 'loadLanguage');
$loadLanguage->setAccessible(true);
$loadLanguage->invoke($lang, $lang_sys_file, $extension);
break;
}
}
// Get the real extension's name now that the language has been loaded
(string) $extension_name = $lang->_($xml->name);
$extension_name = $lang->_((string) $xml->name);
$info[] = JText::sprintf('COM_JEDCHECKER_INFO_XML_NAME_XML', $extension_name);
$info[] = JText::sprintf('COM_JEDCHECKER_INFO_XML_VERSION_XML', (string) $xml->version);
$info[] = JText::sprintf('COM_JEDCHECKER_INFO_XML_CREATIONDATE_XML', (string) $xml->creationDate);
$this->report->addInfo($file, implode('<br />', $info));
// NM3 - Listing name contains “module” or “plugin”
if (preg_match('/\b(?:module|plugin)\b/i', $extension_name))
{
$this->report->addError($file, JText::_('COM_JEDCHECKER_INFO_XML_NAME_MODULE_PLUGIN'));
}
if (stripos($extension_name, 'template') !== false)
{
$this->report->addWarning($file, JText::_('COM_JEDCHECKER_INFO_XML_NAME_RESERVED_KEYWORDS'));
}
// NM5 - Version in name/title
if (preg_match('/(?:\bversion\b|\d\.\d)/i', $extension_name))
{
$this->report->addError($file, JText::_('COM_JEDCHECKER_INFO_XML_NAME_VERSION'));
}
if (stripos($extension_name, 'joomla') === 0)
{
$this->report->addError($file, JText::_('COM_JEDCHECKER_INFO_XML_NAME_JOOMLA'));
}
elseif (stripos($extension_name, 'joom') !== false)
{
$this->report->addWarning($file, JText::_('COM_JEDCHECKER_INFO_XML_NAME_JOOMLA_DERIVATIVE'));
}
$url = (string)$xml->authorUrl;
if (stripos($url, 'joom') !== false)
{
$domain = (strpos($url, '//') === false) ? $url : parse_url(trim($url), PHP_URL_HOST);
if (stripos($domain, 'joom') !== false) {
$this->report->addWarning($file, JText::_('COM_JEDCHECKER_INFO_XML_URL_JOOMLA_DERIVATIVE'));
}
}
if ($type === 'component' && isset($xml->administration->menu))
{
$menu_name = $lang->_((string) $xml->administration->menu);
if ($extension_name !== $menu_name)
{
$this->report->addWarning($file, JText::sprintf('COM_JEDCHECKER_INFO_XML_NAME_ADMIN_MENU', $menu_name, $extension_name));
}
}
if ($type === 'plugin')
{
$group = (string) $xml['group'];
if (strpos($extension_name, ucfirst($group) . ' - ') !== 0)
{
$this->report->addWarning($file, JText::_('COM_JEDCHECKER_INFO_XML_NAME_PLUGIN_FORMAT'));
}
}
// All checks passed. Return true
return true;
}