2021-11-13 21:57:51 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @brief improve, a plugin for Dotclear 2
|
|
|
|
*
|
|
|
|
* @package Dotclear
|
|
|
|
* @subpackage Plugin
|
|
|
|
*
|
|
|
|
* @author Jean-Christian Denis and contributors
|
|
|
|
*
|
|
|
|
* @copyright Jean-Christian Denis
|
|
|
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
|
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
|
2022-12-21 14:41:27 +00:00
|
|
|
namespace Dotclear\Plugin\improve;
|
2021-11-13 21:57:51 +00:00
|
|
|
|
|
|
|
/* clearbricks */
|
|
|
|
use path;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Improve module helper
|
|
|
|
*
|
|
|
|
* Help to load module configuration file (_define.php)
|
|
|
|
* and gather information about it.
|
|
|
|
*/
|
2022-12-21 14:41:27 +00:00
|
|
|
class Module
|
2021-11-13 21:57:51 +00:00
|
|
|
{
|
|
|
|
/** @var array Current module properties */
|
|
|
|
private $properties = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* @param string $type Module type, plugin or theme
|
|
|
|
* @param string $id Module id
|
|
|
|
* @param array $properties Module properties
|
|
|
|
*/
|
|
|
|
public function __construct(string $type, string $id, array $properties = [])
|
|
|
|
{
|
|
|
|
$this->loadDefine($id, $properties['root']);
|
|
|
|
$this->properties = array_merge($this->properties, self::sanitizeModule($type, $id, $properties));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get module properties
|
|
|
|
*
|
|
|
|
* @return array The properties
|
|
|
|
*/
|
|
|
|
public function get(): array
|
|
|
|
{
|
|
|
|
return $this->properties;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get clean properties of registered module
|
|
|
|
*
|
|
|
|
* @param string $type Module type, plugin or theme
|
|
|
|
* @param string $id Module id
|
|
|
|
* @param array $properties Module properties
|
|
|
|
*
|
|
|
|
* @return array Module properties
|
|
|
|
*/
|
|
|
|
public static function clean(string $type, string $id, array $properties): array
|
|
|
|
{
|
|
|
|
$module = new self($type, $id, $properties);
|
|
|
|
|
|
|
|
return $module->get();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Replicate dcModule::loadDefine
|
|
|
|
*
|
|
|
|
* @param string $id Module id
|
|
|
|
* @param string $root Module path
|
|
|
|
*
|
|
|
|
* @return boolean Success
|
|
|
|
*/
|
|
|
|
private function loadDefine(string $id, string $root): bool
|
|
|
|
{
|
|
|
|
if (file_exists($root . '/_define.php')) {
|
|
|
|
ob_start();
|
|
|
|
require $root . '/_define.php';
|
|
|
|
ob_end_clean();
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Replicate dcModule::registerModule
|
|
|
|
*
|
|
|
|
* @param string $name The module name
|
|
|
|
* @param string $desc The module description
|
|
|
|
* @param string $author The module author
|
|
|
|
* @param string $version The module version
|
|
|
|
* @param string|array $properties The properties
|
|
|
|
*
|
|
|
|
* @return boolean Success
|
|
|
|
* @phpstan-ignore-next-line
|
|
|
|
*/
|
|
|
|
private function registerModule(string $name, string $desc, string $author, string $version, $properties = []): bool
|
|
|
|
{
|
|
|
|
if (!is_array($properties)) {
|
|
|
|
$args = func_get_args();
|
|
|
|
$properties = [];
|
|
|
|
if (isset($args[4])) {
|
|
|
|
$properties['permissions'] = $args[4];
|
|
|
|
}
|
|
|
|
if (isset($args[5])) {
|
|
|
|
$properties['priority'] = (int) $args[5];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->properties = array_merge(
|
|
|
|
[
|
|
|
|
'permissions' => null,
|
|
|
|
'priority' => 1000,
|
|
|
|
'standalone_config' => false,
|
|
|
|
'type' => null,
|
|
|
|
'enabled' => true,
|
|
|
|
'requires' => [],
|
|
|
|
'settings' => [],
|
|
|
|
'repository' => '',
|
|
|
|
],
|
|
|
|
$properties
|
|
|
|
);
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Replicate adminModulesList::sanitizeModule
|
|
|
|
*
|
|
|
|
* @param string $type Module type
|
|
|
|
* @param string $id Module id
|
|
|
|
* @param array $properties Module properties
|
|
|
|
*
|
|
|
|
* @return array Sanitized module properties
|
|
|
|
*/
|
|
|
|
public static function sanitizeModule(string $type, string $id, array $properties): array
|
|
|
|
{
|
|
|
|
$label = empty($properties['label']) ? $id : $properties['label'];
|
|
|
|
$name = __(empty($properties['name']) ? $label : $properties['name']);
|
|
|
|
$oname = empty($properties['name']) ? $label : $properties['name'];
|
|
|
|
|
|
|
|
return array_merge(
|
|
|
|
# Default values
|
|
|
|
[
|
|
|
|
'desc' => '',
|
|
|
|
'author' => '',
|
|
|
|
'version' => 0,
|
|
|
|
'current_version' => 0,
|
|
|
|
'root' => '',
|
|
|
|
'root_writable' => false,
|
|
|
|
'permissions' => null,
|
|
|
|
'parent' => null,
|
|
|
|
'priority' => 1000,
|
|
|
|
'standalone_config' => false,
|
|
|
|
'support' => '',
|
|
|
|
'section' => '',
|
|
|
|
'tags' => '',
|
|
|
|
'details' => '',
|
|
|
|
'sshot' => '',
|
|
|
|
'score' => 0,
|
|
|
|
'type' => null,
|
|
|
|
'requires' => [],
|
|
|
|
'settings' => [],
|
|
|
|
'repository' => '',
|
|
|
|
'dc_min' => 0,
|
|
|
|
],
|
|
|
|
# Module's values
|
|
|
|
$properties,
|
|
|
|
# Clean up values
|
|
|
|
[
|
|
|
|
'id' => $id,
|
|
|
|
'sid' => self::sanitizeString($id),
|
|
|
|
'type' => $type,
|
|
|
|
'label' => $label,
|
|
|
|
'name' => $name,
|
|
|
|
'oname' => $oname,
|
|
|
|
'sname' => self::sanitizeString($name),
|
|
|
|
'sroot' => path::real($properties['root']),
|
|
|
|
]
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Replicate adminModulesList::sanitizeString
|
|
|
|
*
|
|
|
|
* @param string $str String to sanitize
|
|
|
|
*
|
|
|
|
* @return string Sanitized string
|
|
|
|
*/
|
|
|
|
public static function sanitizeString(string $str): string
|
|
|
|
{
|
|
|
|
return (string) preg_replace('/[^A-Za-z0-9\@\#+_-]/', '', strtolower($str));
|
|
|
|
}
|
|
|
|
}
|