joomla/jedchecker
33
2
Fork 0
mirror of https://github.com/joomla-extensions/jedchecker.git synced 2025-01-11 17:38:49 +00:00
Code Issues Releases Activity

Merge pull request #26 from JazParkyn/master

Browse Source 
Bootstrapping and adding icons
This commit is contained in:
Jaz Parkyn 2016-03-11 23:51:55 +00:00
commit 6d449f3ff0
7 changed files with 119 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,18 +1,20 @@
; Language files have to start with semicolon (;) otherwise we have problems with transifex
COM_JEDCHECKER_UPLOAD_WAS_SUCCESSFUL="Upload was successful"
COM_JEDCHECKER_UNZIP_SUCCESS="Unzip was successful! Now go ahead and click that check button!"
COM_JEDCHECKER_UPLOAD_FILE="Upload File"
COM_JEDCHECKER_UPLOAD_WAS_SUCCESSFUL="Upload was successful, next click the unzip button."
COM_JEDCHECKER_UNZIP_SUCCESS="Unzip was successful, next click the check button."
COM_JEDCHECKER_UNZIP_FAILED="Unzip failed"
COM_JEDCHECKER_CONGRATS="Congratulations! If you use this component then you've most probably developed a Joomla!® extension! Now comes the &quot;hard&quot; part - getting it listed in the Joomla Extension Directory (JED). The JED has strict requirements to the extensions that get listed there. Those requirements can be found <a href='%s' target='_blank'>here</a>. Currently extensions are being manually tested for code problems. This component is an attempt to simplify your and the JED editors life's by automatically checking the code for common errors in extensions."
COM_JEDCHECKER_CODE_STANDARDS="However our goal is not only to test the extensions against common code errors that prevent it from getting listed in the JED. Our goal is to also have code standards checks such as the <a href='%s' target='_blank'>JPlatform has</a>. This would ensure that joomla extension developers are aware of the JPlatform coding standards and this could raise the quality bar in our Joomla community even higher! For this we will need you! Have a look at the <a href='%s' target='_blank'>github project page</a>. Fork the component! Add your code checks and send us your pull requests!"
COM_JEDCHECKER_HOW_TO_USE="So how to use this component???"
COM_JEDCHECKER_RESULTS="JED Checker Results"
COM_JEDCHECKER_CONGRATS="Congratulations! If you use this component then you've most probably developed a Joomla!® extension! Now comes the &quot;hard&quot; part - getting it listed in the Joomla Extension Directory (JED). The JED has strict requirements to the extensions that get listed there. Those requirements can be found <a href='%s' target='_blank'>here</a>. This component is an attempt to simplify your and the JED editors life's by automatically checking the code for common errors in extensions."
COM_JEDCHECKER_CODE_STANDARDS="However our goal is not only to test the extensions against common code errors that prevent it from getting listed in the JED. Our goal is to also have code standards checks such as the JPlatform has. This would ensure that joomla extension developers are aware of the JPlatform coding standards and this could raise the quality bar in our Joomla community even higher. For this we will need you - have a look at the <a href='%s' target='_blank'>github project page</a>. Fork the component, add your code checks and send us your pull requests!"
COM_JEDCHECKER_HOW_TO_USE="How to check your extension using the JED checker:"
COM_JEDCHECKER_STEP1="Upload your component/plugin/module zip file by using the upload form below"
COM_JEDCHECKER_STEP2="Click on unzip"
COM_JEDCHECKER_STEP3="Click on check and review the results"
COM_JEDCHECKER_WALL_OF_HONOR="Wall of honor"
COM_JEDCHECKER_PEOPLE_THAT_HAVE_HELPED_WITH_THE_DEVELOPMENT="People that have helped with the development of this component. (in no particular order!)"
COM_JEDCHECKER_HOW_TO_INTERPRET_RESULTS="How to interpret the results?"
COM_JEDCHECKER_HOW_TO_INTERPRET_RESULTS="How to Interpret the Results"
COM_JEDCHECKER_RULE_PH2="PHP Files missing JEXEC security"
COM_JEDCHECKER_RULE_PH2_DESC="All the PHP files in your extension needs to have a defined('_JEXEC') or die(); statement in the beginning of each file. This ensures that the file cannot be opened outside of the joomla installation and this way increases the security of your site."
COM_JEDCHECKER_RULE_PH2_DESC="All the PHP files in your extension needs to have a defined('_JEXEC') or die(); statement in the beginning of each file. This ensures that the file cannot be opened outside of the joomla installation and increases the security of your site."
COM_JEDCHECKER_RULE_PH3="License tag missing or incorrect in XML install file"
COM_JEDCHECKER_RULE_PH3_DESC="An install file should include the license information in a license-tag. The license must be GPL or GPL compatible."
COM_JEDCHECKER_EVERYTHING_SEEMS_TO_BE_FINE_WITH_THAT_RULE="Congrats! Everything seems to be fine with that rule!"
@ -26,21 +28,21 @@ COM_JEDCHECKER_RULE="Rule"
COM_JEDCHECKER_ERRORS="Errors"
COM_JEDCHECKER_COMPAT_ISSUES="Compatibility Issues"
COM_JEDCHECKER_IN_LINE="in line"
COM_JEDCHECKER_ERROR_ENCODING="You've used encoding in this file? This is not an error, but an editor will have to review this file!"
COM_JEDCHECKER_ERROR_ENCODING="You've used encoding in this file. This is not an error, but an editor will have to review this file!"
COM_JEDCHECKER_RULE_ENCODING="Base64 or other type of encoding in the files"
COM_JEDCHECKER_RULE_ENCODING_DESC="As developers we are fully aware that the base64 and similar functions have a valid place in each extensions(like URL redirects or data storage). However if you use those to make it harder for users to read your code or to mask backlinks the JED might not accept your listing submission (this is not in the spirit of GPL anyway!). An editor will review your code and determine if the way you use the base64 matches the rules of the JED. This might slow your listing review time. So the rule of thumb is - don't do fishy stuff and avoid encoding your code if possible!"
COM_JEDCHECKER_RULE_ENCODING_DESC="As developers we are fully aware that the base64 and similar functions have a valid place in extensions (such as URL redirects or data storage). However if you use those to make it harder for users to read your code or to mask backlinks the JED might not accept your listing submission (this is not in the spirit of GPL anyway!). An editor will review your code and determine if the way you use the base64 matches the rules of the JED. This might slow your listing review time. So the rule of thumb is - don't do fishy stuff and avoid encoding your code if possible!"
COM_JEDCHECKER_ERROR_ERRORREPORTING="You've used error_reporting(0) in this file."
COM_JEDCHECKER_RULE_ERRORREPORTING="error_reporting(0) in the files"
COM_JEDCHECKER_RULE_ERRORREPORTING_DESC="Using error_reporting(0) is discouraged as Joomla provides an error_reporting option in the Global Configuration. Currently your extensions will be published on the JED if you have this in your files, but this might change in the future! So better don't use this to disable the error reporting."
COM_JEDCHECKER_RULE_ERRORREPORTING_DESC="Use of error_reporting(0) is discouraged as Joomla provides an error_reporting option in the Global Configuration."
COM_JEDCHECKER_LEAVE_A_REVIEW_JED="If you use this component, please post a rating and a review at the <a href='%s' title='JED' target='_blank'>Joomla! Extensions Directory</a>."
COM_JEDCHECKER_INFO="Info"
COM_JEDCHECKER_INFO_XML="Just some info about the extension xml files"
COM_JEDCHECKER_INFO_XML_DESC="This is not a rule, just a convenience check. We go through the xml files and grab the value for the name tag. Useful information for the &quot;filename and install as&quot; fields in the jed submission form"
COM_JEDCHECKER_INFO_XML="Information about extension xml files"
COM_JEDCHECKER_INFO_XML_DESC="The install name of your extension must match your listing name on JED. We go through the xml files and grab the value for the name tag. Useful information for the &quot;filename and install as&quot; fields in the jed submission form"
COM_JEDCHECKER_INFO_XML_NAME_XML="The name tag in this file is: %s"
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_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). More info <a href='http://extensions.joomla.org/index.php?option=com_content&id=50' target='_blank'>here</a>."
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"
COM_JEDCHECKER_PH1_LICENSE_FOUND="GPL license was found"
COM_JEDCHECKER_GPL_COMPATIBLE_LICENSE_WAS_FOUND="GPL compatible license was found"
@ -50,12 +52,12 @@ COM_JEDCHECKER_OLD_RULE_X_PHP_FILE_NOT_REMOVED="PHP file for '%s' rule could not
COM_JEDCHECKER_OLD_RULE_X_PHP_FILE_REMOVED="Removed PHP file for '%s' rule."
COM_JEDCHECKER_OLD_RULE_X_INI_FILE_REMOVED="Removed 'ini' file for '%s' rule."
COM_JEDCHECKER_RULE_FRAMEWORK="Joomla framework deprecated and unsafe"
COM_JEDCHECKER_RULE_FRAMEWORK_DESC="Warns about <ul><li>superglobals<li>commonly used but deprecated functions<li>highly unsafe functions</ul>Find more info <a href='http://docs.joomla.org/Potential_backward_compatibility_issues_in_Joomla_3.0_and_Joomla_Platform_12.1' target='_blank'>on Joomla backward compatibility for Joomla 3</a>"
COM_JEDCHECKER_ERROR_FRAMEWORK_SUPERGLOBALS="You shouldn't use superglobals"
COM_JEDCHECKER_ERROR_FRAMEWORK_DIRECTDB="You are using direct db access"
COM_JEDCHECKER_RULE_FRAMEWORK_DESC="Warns about <ul><li>superglobals</li><li>commonly used but deprecated functions</li><li>highly unsafe functions</li></ul>Find more info <a href='http://docs.joomla.org/Potential_backward_compatibility_issues_in_Joomla_3.0_and_Joomla_Platform_12.1' target='_blank'>on Joomla backward compatibility for Joomla 3</a>"
COM_JEDCHECKER_ERROR_FRAMEWORK_SUPERGLOBALS="Use of superglobals is strongly discouraged"
COM_JEDCHECKER_ERROR_FRAMEWORK_DIRECTDB="Use of direct db access is strongly discouraged"
COM_JEDCHECKER_RULE_FRAMEWORK_NOTINJ3="Functions removed from Joomla 3"
COM_JEDCHECKER_ERROR_FRAMEWORK_NOTINJ3="n/a in Joomla 3"
COM_JEDCHECKER_ERROR_FRAMEWORK_DS="DS n/a in Joomla 3"
COM_JEDCHECKER_ERROR_FRAMEWORK_NOTINJ3="not in Joomla 3"
COM_JEDCHECKER_ERROR_FRAMEWORK_DS="DS not in Joomla 3"
COM_JEDCHECKER_ERROR_FRAMEWORK_JERR="JError is deprecated, you should use application->enqueueMessages()"
COM_JEDCHECKER_ERROR_FRAMEWORK_ERRORLOG="error_log and var_dump"
COM_JEDCHECKER_ERROR_FRAMEWORK_DEPRECATED="JRequest is deprecated and behaves funny with cache"

12
source/administrator/components/com_jedchecker/models/report.php
View File

@ -165,9 +165,9 @@ class JEDcheckerReport extends JObject
if ($this->data['count']->total == 0)
{
// No errors or compatibility issues found
$html[] = '<span class="success">';
$html[] = '<div class="alert alert-success">';
$html[] = JText::_('COM_JEDCHECKER_EVERYTHING_SEEMS_TO_BE_FINE_WITH_THAT_RULE');
$html[] = '</span>';
$html[] = '</div>';
}
else
{
@ -180,7 +180,7 @@ class JEDcheckerReport extends JObject
if ($error_count > 0)
{
$html[] = '<strong>' . $error_count . ' ' . JText::_('COM_JEDCHECKER_ERRORS') . '</strong>';
$html[] = '<ul class="jedchecker-rule-errors">';
$html[] = '<ul class="alert alert-danger">';
foreach ($this->data['errors'] AS $i => $item)
{
@ -212,7 +212,7 @@ class JEDcheckerReport extends JObject
if ($compat_count > 0)
{
$html[] = '<strong>' . $compat_count . ' ' . JText::_('COM_JEDCHECKER_COMPAT_ISSUES') . '</strong>';
$html[] = '<ul class="jedchecker-rule-compat">';
$html[] = '<ul class="alert alert-warning">';
foreach ($this->data['compat'] AS $i => $item)
{
@ -246,7 +246,7 @@ class JEDcheckerReport extends JObject
if ($info_count > 0)
{
$html[] = '<strong>' . $info_count . ' ' . JText::_('COM_JEDCHECKER_INFO') . '</strong>';
$html[] = '<ul class="jedchecker-info-message">';
$html[] = '<ul class="alert alert-info">';
foreach ($this->data['info'] AS $i => $item)
{
@ -280,7 +280,7 @@ class JEDcheckerReport extends JObject
if ($warning_count > 0)
{
$html[] = '<strong>' . $warning_count . ' ' . JText::_('COM_JEDCHECKER_WARNING') . '</strong>';
$html[] = '<ul class="jedchecker-warning-message">';
$html[] = '<ul class="alert alert-warning">';
foreach ($this->data['warning'] AS $i => $item)
{

26
source/administrator/components/com_jedchecker/views/uploads/tmpl/default.php
View File

@ -25,8 +25,8 @@ JHtml::script('media/com_jedchecker/js/police.js');
Joomla.submitform(task);
}
</script>
<div class="fltlft width-60 span8">
<div class="row-fluid">
<div class="span8">
<form action="<?php echo JRoute::_('index.php?option=com_jedchecker&view=uploads'); ?>"
method="post" class="form form-validate" name="adminForm" id="adminForm" enctype="multipart/form-data">
<fieldset>
@ -49,16 +49,16 @@ JHtml::script('media/com_jedchecker/js/police.js');
<input type="file" name="extension" class="required"/>
<button onclick="Joomla.submitbutton('uploads.upload')">
<?php echo JText::_('JSUBMIT'); ?>
<button onclick="Joomla.submitbutton('uploads.upload')" class="btn btn-success">
<span class="icon-upload "></span> <?php echo JText::_('JSUBMIT'); ?>
</button>
<input type="hidden" name="task" value=""/>
<?php echo JHTML::_('form.token'); ?>
</fieldset>
</form>
</div>
<div class="fltrt width-40 span4">
<div class="help">
</div>
<div class="span4">
<div class="well">
<h2><?php echo JText::_('COM_JEDCHECKER_WALL_OF_HONOR'); ?></h2>
<p><?php echo JText::_('COM_JEDCHECKER_PEOPLE_THAT_HAVE_HELPED_WITH_THE_DEVELOPMENT'); ?></p>
@ -71,15 +71,18 @@ JHtml::script('media/com_jedchecker/js/police.js');
<li>OpenTranslators (<a href="http://opentranslators.org" target="_blank">opentranslators.org</a>)</li>
<li>Riccardo Zorn (<a href="http://fasterjoomla.com" target="_blank">fasterjoomla.com</a>)</li>
<li>Bernard Toplak (<a href="http://www.orion-web.hr/en/" target="_blank">orion-web.hr</a>)</li>
<li>Jaz Parkyn (<a href="http://www.pixeldustsolutions.com" target="_blank">Pixel Dust Solutions</a>)</li>
</ul>
</div>
</div>
</div>
<div id="prison" style="display:none;">
<div class="fltlft width-60 span8">
<div id="police-check-result"></div>
<div class="row-fluid">
<div class="span8">
<div id="police-check-result" class="well"><h2 style="padding-left:10px;"><?php echo JText::_('COM_JEDCHECKER_RESULTS'); ?></h2></div>
</div>
<div class="fltrt width-40 span4">
<div class="help">
<div class="span4">
<div class="well">
<h2>
<?php echo JText::_('COM_JEDCHECKER_HOW_TO_INTERPRET_RESULTS'); ?>
</h2>
@ -106,6 +109,7 @@ JHtml::script('media/com_jedchecker/js/police.js');
</ul>
</div>
</div>
</div>
</div>
<div class="clr clearfix"></div>
<div class="copyright row-fluid">

4
source/administrator/components/com_jedchecker/views/uploads/view.html.php
View File

@ -61,12 +61,12 @@ class JedcheckerViewUploads extends JViewLegacy
{
if ($this->filesExist('archives'))
{
JToolBarHelper::custom('uploads.unzip', 'unzip', 'unzip', 'unzip', false);
JToolBarHelper::custom('uploads.unzip', 'folder', 'folder', 'unzip', false);
}
if ($this->filesExist('unzipped'))
{
JToolBarHelper::custom('police.check', 'police-check', 'police-check', 'Check', false);
JToolBarHelper::custom('police.check', 'search', 'search', 'Check', false);
}
JToolBarHelper::title('JED checker');

74
source/media/com_jedchecker/css/css.css
View File

@ -1,35 +1,18 @@
.icon-32-unzip {
background-image: url(../icons/unzip.png);
}
.icon-32-police-check {
background-image: url(../icons/inspect.png);
}
#adminForm {
background: #FFF;
}
#police-check-result {
background: #F6F6F6;
border: 1px solid #CCC;
padding: 0;
}
#police-check-result div:nth-child(odd){
border-bottom: 1px solid #CCCCCC;
#police-check-result > div {
border-top: 1px solid #ccc;
padding: 5px 10px;
}
#police-check-result div:nth-child(even){
background: #EBF1F2;
}
#police-check-result div {
padding: 5px 10px 5px;
}
.help {
padding: 5px;
border: 1px solid #CCCCCC;
background: #FFF;
margin-left: 10px;
#police-check-result .alert {
margin: 5px 0;
}
.copyright {
@ -42,38 +25,6 @@
font-weight: bold;
}
.success {
color: green;
font-weight: bold;
}
.jedchecker-info-message,
.jedchecker-warning-message,
.jedchecker-rule-compat,
.jedchecker-rule-errors {
background: #ebf1f6;
background: linear-gradient(120deg, #EBF1F6 0%,#ABD3EE 50%,#89C3EB 51%,#D5EBFB 100%);
border: 1px solid #BCE8F1;
color: #1A678D;
margin: 5px;
padding: 5px;
list-style:none;
}
.jedchecker-rule-errors {
background: #FFFFFF;
background: linear-gradient(to right, #FFFFFF 0%,#FFFFFF 94%,#C72200 99%);
color:#BC0000;
}
.jedchecker-warning-message {
background: #FFB76B;
background: linear-gradient(120deg, #FFC77B 0%, #FFC75D 44%, #FF8930 55%, #FFBC40 68%, #FF9F24 100%);
color:black;
}
.jedchecker-rule-compat {
background: #FCECFC;
background: linear-gradient(120deg, #FCECFC 0%, #FFB6F1 50%, #FFA9F7 54%, #FFDCFF 100%);
}
small {
font-size: 110%;
padding: 0 0 0 30px;
@ -85,15 +36,16 @@ small {
overflow:hidden;
}
#police-check-result ul li pre {
display:inline-block;
padding-left:2em;
font-size: 110%;
background: white none repeat scroll 0 0;
border: 1px solid #ccc;
display: block;
margin: 0;
overflow: hidden;
padding: 2px 6px;
text-overflow: ellipsis;
vertical-align: middle;
white-space: nowrap;
margin:0;
}
}
.jamss_tooltip {
background-color:blue;

BIN
source/media/com_jedchecker/icons/inspect.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 2.1 KiB

BIN
source/media/com_jedchecker/icons/unzip.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 2.3 KiB