jedchecker/administrator/components/com_jedchecker/libraries/rules/gpl.php

<?php
/**
 * @package    Joomla.JEDChecker
 *
 * @copyright  Copyright (C) 2017 - 2019 Open Source Matters, Inc. All rights reserved.
 * 			   Copyright (C) 2008 - 2016 compojoom.com . All rights reserved.
 * @author     Daniel Dimitrov <daniel@compojoom.com>
 *
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\Filesystem\Folder;
use Joomla\CMS\Language\Text;

// Include the rule base class
require_once JPATH_COMPONENT_ADMINISTRATOR . '/models/rule.php';


/**
 * class JedcheckerRulesGpl
 *
 * This class searches all files for the GPL/compatible licenses
 *
 * @since  1.0
 */
class JedcheckerRulesGpl extends JEDcheckerRule
{
	/**
	 * The formal ID of this rule. For example: SE1.
	 *
	 * @var    string
	 */
	protected $id = 'PH1';

	/**
	 * The title or caption of this rule.
	 *
	 * @var    string
	 */
	protected $title = 'COM_JEDCHECKER_RULE_PH1';

	/**
	 * The description of this rule.
	 *
	 * @var    string
	 */
	protected $description = 'COM_JEDCHECKER_RULE_PH1_DESC';

	/**
	 * The ordering value to sort rules in the menu.
	 *
	 * @var    integer
	 */
	public static $ordering = 500;

	/**
	 * Regular expression to match GPL licenses.
	 *
	 * @var    string
	 */
	protected $regexGPLLicenses;

	/**
	 * Regular expression to match GPL-compatible licenses.
	 *
	 * @var    string
	 */
	protected $regexCompatLicenses;

	/**
	 * Initiates the file search and check
	 *
	 * @return    void
	 */
	public function check()
	{
		$this->report->setDefaultSubtype($this->id);

		// Prepare regexp
		$this->init();

		// Find all php files of the extension
		$files = Folder::files($this->basedir, '\.php$', true, true);

		// Iterate through all files
		foreach ($files as $file)
		{
			// Try to find the _JEXEC check in the file
			if (!$this->find($file))
			{
				// Add as error to the report if it was not found
				$this->report->addError($file, Text::_('COM_JEDCHECKER_ERROR_GPL_NOT_FOUND'));
			}
		}
	}

	/**
	 * Initialization (prepare regular expressions)
	 *
	 * @return    void
	 */
	protected function init()
	{
		$GPLLicenses = (array) file(__DIR__ . '/gpl/gnu.txt');
		$this->regexGPLLicenses = $this->generateRegexp($GPLLicenses);

		$compatLicenses = (array) file(__DIR__ . '/gpl/compat.txt');

		$extraLicenses = $this->params->get('constants', '');
		$extraLicenses = explode(',', $extraLicenses);

		$compatLicenses = array_merge($compatLicenses, $extraLicenses);

		$this->regexCompatLicenses = $this->generateRegexp($compatLicenses);
	}

	/**
	 * Generate regular expression to match the given list of license names
	 * @param   array $lines List of license names
	 *
	 * @return string
	 */
	protected function generateRegexp($lines)
	{
		$titles = array();
		$ids = array();

		foreach ($lines as $line)
		{
			$line = trim($line);

			if ($line === '' || $line[0] === '#')
			{
				// Skip empty and commented lines
				continue;
			}

			$title = $line;
			if (substr($line, -1, 1) === ')')
			{
				// Extract identifier
				$pos = strrpos($line, '(');

				if ($pos !== false)
				{
					$title = trim(substr($line, 0, $pos));

					$id = trim(substr($line, $pos + 1, -1));

					if ($id !== '')
					{
						$id = preg_quote($id, '#');
						$ids[$id] = 1;
					}
				}
			}

			if ($title !== '')
			{
				$title = preg_quote($title, '#');

				// Expand vN.N to different version formats
				$title = preg_replace('/(?<=\S)\s+v(?=\d)/', ',?\s+(?:v\.?\s*|version\s+)?', $title);

				$title = preg_replace('/\s+/', '\s+', $title);

				$titles[$title] = 1;
			}
		}

		if (count($titles) === 0)
		{
			return null;
		}

		$titles = implode('|', array_keys($titles));

		if (count($ids))
		{
			$ids = implode('|', array_keys($ids));
			$titles .=
				'|\blicense\b.+?(?:' . $ids . ')' .
				'|\b(?:' . $ids . ')\s+license\b';
		}

		return '#^.*?(?:' . $titles . ').*?$#im';
	}

	/**
	 * Reads a file and searches for its license
	 *
	 * @param   string  $file  - The path to the file
	 *
	 * @return boolean True if the statement was found, otherwise False.
	 */
	protected function find($file)
	{
		$content = php_strip_whitespace($file);

		// Check the file is empty, comments-only, or nonexecutable
		if (empty($content) || preg_match('#^<\?php\s+(?:$|(?:die|exit)(?:\(\))?;)#', $content))
		{
			return true;
		}

		// Reload file to preserve comments and line numbers
		$content = file_get_contents($file);

		// Remove leading "*" characters from phpDoc-like comments
		$content = preg_replace('/^\s*\*/m', '', $content);

		if (preg_match($this->regexGPLLicenses, $content, $match, PREG_OFFSET_CAPTURE))
		{
			$lineno = substr_count($content, "\n", 0, $match[0][1]) + 1;
			$this->report->addPassed(
				$file,
				Text::_('COM_JEDCHECKER_PH1_LICENSE_FOUND'),
				$lineno,
				$match[0][0]
			);

			return true;
		}

		if (preg_match($this->regexCompatLicenses, $content, $match, PREG_OFFSET_CAPTURE))
		{
			$lineno = substr_count($content, "\n", 0, $match[0][1]) + 1;
			$this->report->addWarning(
				$file,
				Text::_('COM_JEDCHECKER_GPL_COMPATIBLE_LICENSE_WAS_FOUND'),
				$lineno,
				$match[0][0]
			);

			return true;
		}

		return false;
	}
}