' .
- __('Use comma separated list of extensions without dot, recommand "php,js,xml,txt,md".') .
- '
';
- }
-
- public function readFile(string &$content): ?bool
- {
- $ext = $this->getSetting('extensions');
- if (!is_array($ext) || !in_array($this->path_extension, $ext)) {
- return null;
- }
- $clean = (string) preg_replace(
- '/(\n\s+\n)/',
- "\n\n",
- (string) preg_replace(
- '/(\n\n+)/',
- "\n\n",
- (string) str_replace(
- ["\r\n", "\r"],
- "\n",
- $content
- )
- )
- );
- if ($content != $clean) {
- $this->setSuccess(__('Replace bad new lines'));
- $content = $clean;
- }
-
- return true;
- }
-}
-
-class ImproveActionEndoffile extends ImproveAction
-{
- protected function init(): bool
- {
- $this->setProperties([
- 'id' => 'endoffile',
- 'name' => __('End of files'),
- 'description' => __('Remove php tag and empty lines from end of files'),
- 'priority' => 860,
- 'configurator' => true,
- 'types' => ['plugin', 'theme']
- ]);
-
- return true;
- }
-
- public function isConfigured(): bool
- {
- return true;
- }
-
- public function configure($url): ?string
- {
- if (!empty($_POST['save'])) {
- $this->setSettings('psr2', !empty($_POST['endoffile_psr2']));
- $this->redirect($url);
- }
-
- return
- '' .
- __('PSR2 must have a blank line, whereas PSR12 must not.') .
- '
';
- }
-
- public function readFile(&$content): ?bool
- {
- if (!in_array($this->path_extension, ['php', 'md'])) {
- return null;
- }
- $clean = preg_replace(
- ['/(\s*)(\?>\s*)$/', '/\n+$/'],
- '',
- $content
- ) . ($this->getSetting('psr2') ? "\n" : '');
- if ($content != $clean) {
- $this->setSuccess(__('Replace end of file'));
- $content = $clean;
- }
-
- return true;
- }
-}
diff --git a/inc/lib.improve.action.dcdeprecated.php b/inc/module/dcdeprecated.php
similarity index 92%
rename from inc/lib.improve.action.dcdeprecated.php
rename to inc/module/dcdeprecated.php
index cbaa528..1e362ea 100644
--- a/inc/lib.improve.action.dcdeprecated.php
+++ b/inc/module/dcdeprecated.php
@@ -10,7 +10,17 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionDcdeprecated extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/**
+ * Improve action module Dotclear depreciated
+ */
+class dcdeprecated extends action
{
/** @var array Deprecated functions [filetype [pattern, deprecated, replacement, version]] */
private static $deprecated = [
@@ -44,7 +54,7 @@ class ImproveActionDcdeprecated extends ImproveAction
['adminPostForm[^I]', 'adminPostForm', 'adminPostFormItems'],
['adminPostFormSidebar', 'adminPostFormSidebar', 'adminPostFormItems'],
- ['three-cols', 'three-cols', 'three-boxes', '2.6']
+ ['three-cols', 'three-cols', 'three-boxes', '2.6'],
],
'js' => [
['\sstoreLocalData', 'storeLocalData', 'dotclear.storeLocalData'],
@@ -55,8 +65,8 @@ class ImproveActionDcdeprecated extends ImproveAction
['\smergeDeep', 'mergeDeep', 'dotclear.mergeDeep'],
['\sgetCookie', 'getCookie', 'dotclear.getCookie'],
['\ssetCookie', 'setCookie', 'dotclear.setCookie'],
- ['\sdeleteCookie', 'deleteCookie', 'dotclear.deleteCookie']
- ]
+ ['\sdeleteCookie', 'deleteCookie', 'dotclear.deleteCookie'],
+ ],
];
protected function init(): bool
@@ -66,7 +76,7 @@ class ImproveActionDcdeprecated extends ImproveAction
'name' => __('Dotclear deprecated'),
'description' => __('Search for use of deprecated Dotclear functions'),
'priority' => 520,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
return true;
diff --git a/inc/lib.improve.action.dcstore.php b/inc/module/dcstore.php
similarity index 89%
rename from inc/lib.improve.action.dcstore.php
rename to inc/module/dcstore.php
index b77173d..6414fcc 100644
--- a/inc/lib.improve.action.dcstore.php
+++ b/inc/module/dcstore.php
@@ -10,8 +10,31 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionDcstore extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* clearbricks */
+use form;
+use files;
+use text;
+use xmlTag;
+use DOMDocument;
+
+/* php */
+use Exception;
+
+/**
+ * Improve action module dcstore.xml
+ */
+class dcstore extends action
{
+ /** @var string Settings dcstore zip url pattern */
+ private $pattern = '';
+
protected function init(): bool
{
$this->setProperties([
@@ -20,9 +43,12 @@ class ImproveActionDcstore extends ImproveAction
'description' => __('Re-create dcstore.xml file according to _define.php variables'),
'priority' => 420,
'configurator' => true,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
+ $pattern = $this->getSetting('pattern');
+ $this->pattern = is_string($pattern) ? $pattern : '';
+
return true;
}
@@ -42,7 +68,7 @@ class ImproveActionDcstore extends ImproveAction
'' . __('File will be overwritten if it exists') . '
' .
'' .
sprintf(__('You can use wildcards %s'), '%author%, %type%, %id%, %version%.') .
@@ -187,25 +213,20 @@ class ImproveActionDcstore extends ImproveAction
private function parseFilePattern(): string
{
- $str = $this->getSetting('pattern');
- if (!is_string($str)) {
- return '';
- }
-
return text::tidyURL(str_replace(
[
'%type%',
'%id%',
'%version%',
- '%author%'
+ '%author%',
],
[
$this->module['type'],
$this->module['id'],
$this->module['version'],
- $this->module['author']
+ $this->module['author'],
],
- $str
+ $this->pattern
));
}
}
diff --git a/inc/module/endoffile.php b/inc/module/endoffile.php
new file mode 100644
index 0000000..96c2b25
--- /dev/null
+++ b/inc/module/endoffile.php
@@ -0,0 +1,80 @@
+setProperties([
+ 'id' => 'endoffile',
+ 'name' => __('End of files'),
+ 'description' => __('Remove php tag and empty lines from end of files'),
+ 'priority' => 860,
+ 'configurator' => true,
+ 'types' => ['plugin', 'theme'],
+ ]);
+
+ return true;
+ }
+
+ public function isConfigured(): bool
+ {
+ return true;
+ }
+
+ public function configure($url): ?string
+ {
+ if (!empty($_POST['save'])) {
+ $this->setSettings('psr2', !empty($_POST['endoffile_psr2']));
+ $this->redirect($url);
+ }
+
+ return
+ '
' .
+ __('PSR2 must have a blank line, whereas PSR12 must not.') .
+ '
';
+ }
+
+ public function readFile(&$content): ?bool
+ {
+ if (!in_array($this->path_extension, ['php', 'md'])) {
+ return null;
+ }
+ $clean = preg_replace(
+ ['/(\s*)(\?>\s*)$/', '/\n+$/'],
+ '',
+ $content
+ ) . ($this->getSetting('psr2') ? "\n" : '');
+ if ($content != $clean) {
+ $this->setSuccess(__('Replace end of file'));
+ $content = $clean;
+ }
+
+ return true;
+ }
+}
diff --git a/inc/lib.improve.action.gitshields.php b/inc/module/gitshields.php
similarity index 83%
rename from inc/lib.improve.action.gitshields.php
rename to inc/module/gitshields.php
index eba9080..3bafafd 100644
--- a/inc/lib.improve.action.gitshields.php
+++ b/inc/module/gitshields.php
@@ -10,8 +10,27 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionGitshields extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* clearbricks */
+use form;
+
+/**
+ * Improve action module Github shields.io
+ */
+class gitshields extends action
{
+ /** @var string Username of git repo */
+ private $username = '';
+
+ /** @var boolean add Dotaddict shield */
+ private $dotaddict = false;
+
/** @var boolean Stop scaning files */
private $stop_scan = false;
@@ -21,7 +40,7 @@ class ImproveActionGitshields extends ImproveAction
/** @var array Search patterns */
protected $bloc_pattern = [
'remove' => '/\[!\[Release(.*)LICENSE\)/ms',
- 'target' => '/^([^\n]+)[\r\n|\n]{1,}/ms'
+ 'target' => '/^([^\n]+)[\r\n|\n]{1,}/ms',
];
/** @var array Shields patterns */
@@ -31,7 +50,7 @@ class ImproveActionGitshields extends ImproveAction
'issues' => '[](https://github.com/%username%/%module%/issues)',
'dotclear' => '[](https://fr.dotclear.org/download)',
'dotaddict' => '[](https://%type%s.dotaddict.org/dc2/details/%module%)',
- 'license' => '[](https://github.com/%username%/%module%/blob/master/LICENSE)'
+ 'license' => '[](https://github.com/%username%/%module%/blob/master/LICENSE)',
];
protected function init(): bool
@@ -42,9 +61,13 @@ class ImproveActionGitshields extends ImproveAction
'description' => __('Add and maintain shields.io badges to the REDAME.md file'),
'priority' => 380,
'configurator' => true,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
+ $username = $this->getSetting('username');
+ $this->username = is_string($username) ? $username : '';
+ $this->dotaddict = (bool) $this->getSetting('dotaddict');
+
return true;
}
@@ -58,19 +81,19 @@ class ImproveActionGitshields extends ImproveAction
if (!empty($_POST['save']) && !empty($_POST['username'])) {
$this->setSettings([
'username' => (string) $_POST['username'],
- 'dotaddict' => !empty($_POST['dotaddict'])
+ 'dotaddict' => !empty($_POST['dotaddict']),
]);
$this->redirect($url);
}
return '
' . __('Used in your Github URL: http://github.com/username/module_id.') . '
' . __('If your plugin or theme is on Dotaddict, you can add a badge to link to its details in Dotaddict.') . '
';
}
@@ -99,7 +122,7 @@ class ImproveActionGitshields extends ImproveAction
{
$blocs = [];
foreach ($this->bloc_content as $k => $v) {
- if ($k == 'dotaddict' && empty($this->getSetting('dotaddict'))) {
+ if ($k == 'dotaddict' && !$this->dotaddict) {
continue;
}
$blocs[$k] = trim(str_replace(
@@ -108,14 +131,14 @@ class ImproveActionGitshields extends ImproveAction
'%module%',
'%dotclear%',
'%type%',
- "\r\n", "\n"
+ "\r\n", "\n",
],
[
- $this->getSetting('username'),
+ $this->username,
$this->module['id'],
$dotclear = $this->getDotclearVersion(),
$this->module['type'],
- '', ''
+ '', '',
],
$v
));
diff --git a/inc/lib.improve.action.licensefile.php b/inc/module/licensefile.php
similarity index 90%
rename from inc/lib.improve.action.licensefile.php
rename to inc/module/licensefile.php
index bc6f180..3063ec3 100644
--- a/inc/lib.improve.action.licensefile.php
+++ b/inc/module/licensefile.php
@@ -10,13 +10,30 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionLicensefile extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* clearbricks */
+use form;
+use files;
+
+/* php */
+use Exception;
+
+/**
+ * Improve action module license file
+ */
+class licensefile extends action
{
/** @var array Possible license filenames */
protected static $license_filenames = [
'license',
'license.md',
- 'license.txt'
+ 'license.txt',
];
/** @var array Possible license names */
@@ -33,21 +50,21 @@ class ImproveActionLicensefile extends ImproveAction
'description' => __('Add or remove full license file to module root'),
'priority' => 330,
'configurator' => true,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
$this->action_version = [
__('no version selected') => '',
__('gpl2 - GNU General Public License v2') => 'gpl2',
__('gpl3 - GNU General Public License v3') => 'gpl3',
__('lgpl3 - GNU Lesser General Public License v3') => 'lgpl3',
- __('Massachusetts Institute of Technolog mit') => 'mit'
+ __('Massachusetts Institute of Technolog mit') => 'mit',
];
$this->action_full = [
__('Do nothing') => 0,
__('Add file if it does not exist') => 'create',
__('Add file even if it exists') => 'overwrite',
__('Add file and remove others') => 'full',
- __('Remove license files') => 'remove'
+ __('Remove license files') => 'remove',
];
return true;
@@ -63,7 +80,7 @@ class ImproveActionLicensefile extends ImproveAction
if (!empty($_POST['save'])) {
$this->setSettings([
'action_version' => !empty($_POST['action_version']) ? $_POST['action_version'] : '',
- 'action_full' => !empty($_POST['action_full']) ? $_POST['action_full'] : ''
+ 'action_full' => !empty($_POST['action_full']) ? $_POST['action_full'] : '',
]);
$this->redirect($url);
}
@@ -97,7 +114,7 @@ class ImproveActionLicensefile extends ImproveAction
private function writeFullLicense(): ?bool
{
try {
- $full = file_get_contents(dirname(__FILE__) . '/license/' . $this->getSetting('action_version') . '.full.txt');
+ $full = file_get_contents(dirname(__FILE__) . '/licensefile/' . $this->getSetting('action_version') . '.full.txt');
if (empty($full)) {
$this->setError(__('Failed to load license content'));
diff --git a/inc/license/gpl2.full.txt b/inc/module/licensefile/gpl2.full.txt
similarity index 100%
rename from inc/license/gpl2.full.txt
rename to inc/module/licensefile/gpl2.full.txt
diff --git a/inc/license/gpl3.full.txt b/inc/module/licensefile/gpl3.full.txt
similarity index 100%
rename from inc/license/gpl3.full.txt
rename to inc/module/licensefile/gpl3.full.txt
diff --git a/inc/license/lgpl3.full.txt b/inc/module/licensefile/lgpl3.full.txt
similarity index 100%
rename from inc/license/lgpl3.full.txt
rename to inc/module/licensefile/lgpl3.full.txt
diff --git a/inc/license/mit.full.txt b/inc/module/licensefile/mit.full.txt
similarity index 100%
rename from inc/license/mit.full.txt
rename to inc/module/licensefile/mit.full.txt
diff --git a/inc/module/newline.php b/inc/module/newline.php
new file mode 100644
index 0000000..949633f
--- /dev/null
+++ b/inc/module/newline.php
@@ -0,0 +1,104 @@
+setProperties([
+ 'id' => 'newline',
+ 'name' => __('Newlines'),
+ 'description' => __('Replace bad and repetitive and empty newline by single newline in files'),
+ 'priority' => 840,
+ 'configurator' => true,
+ 'types' => ['plugin', 'theme'],
+ ]);
+ /*
+ $ext = @unserialize($this->core->blog->settings->improve->newline_extensions);
+ $ext = Improve::cleanExtensions($ext);
+ if (!empty($ext)) {
+ $this->extensions = $ext;
+ }
+ */
+ return true;
+ }
+
+ public function isConfigured(): bool
+ {
+ return !empty($this->getSetting('extensions'));
+ }
+
+ public function configure($url): ?string
+ {
+ if (!empty($_POST['save']) && !empty($_POST['newline_extensions'])) {
+ $this->setSettings(
+ 'extensions',
+ improve::cleanExtensions($_POST['newline_extensions'])
+ );
+ $this->redirect($url);
+ }
+
+ $ext = $this->getSetting('extensions');
+ if (!is_array($ext)) {
+ $ext = [];
+ }
+
+ return
+ '' .
+ __('Use comma separated list of extensions without dot, recommand "php,js,xml,txt,md".') .
+ '
';
+ }
+
+ public function readFile(string &$content): ?bool
+ {
+ $ext = $this->getSetting('extensions');
+ if (!is_array($ext) || !in_array($this->path_extension, $ext)) {
+ return null;
+ }
+ $clean = (string) preg_replace(
+ '/(\n\s+\n)/',
+ "\n\n",
+ (string) preg_replace(
+ '/(\n\n+)/',
+ "\n\n",
+ (string) str_replace(
+ ["\r\n", "\r"],
+ "\n",
+ $content
+ )
+ )
+ );
+ if ($content != $clean) {
+ $this->setSuccess(__('Replace bad new lines'));
+ $content = $clean;
+ }
+
+ return true;
+ }
+}
diff --git a/inc/lib.improve.action.phpcsfixer.php b/inc/module/phpcsfixer.php
similarity index 85%
rename from inc/lib.improve.action.phpcsfixer.php
rename to inc/module/phpcsfixer.php
index a88ef09..dfa6f4c 100644
--- a/inc/lib.improve.action.phpcsfixer.php
+++ b/inc/module/phpcsfixer.php
@@ -10,7 +10,28 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionPhpcsfixer extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* dotclear */
+use dcPage;
+
+/* clearbricks */
+use html;
+use form;
+use path;
+
+/* php */
+use Exception;
+
+/**
+ * Improve action module PHP CS Fixer
+ */
+class phpcsfixer extends action
{
/** @var array Type of runtime errors */
protected static $errors = [
@@ -20,7 +41,7 @@ class ImproveActionPhpcsfixer extends ImproveAction
8 => 'Some files need fixing (only in dry-run mode).',
16 => 'Configuration error of the application.',
32 => 'Configuration error of a Fixer.',
- 64 => 'Exception raised within the application'
+ 64 => 'Exception raised within the application',
];
/** @var boolean User pref to use colored synthax */
@@ -40,7 +61,7 @@ class ImproveActionPhpcsfixer extends ImproveAction
'description' => __('Fix PSR coding style using Php CS Fixer'),
'priority' => 920,
'configurator' => true,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
$this->getPhpPath();
@@ -70,11 +91,11 @@ class ImproveActionPhpcsfixer extends ImproveAction
{
if (!empty($_POST['save'])) {
$this->setSettings([
- 'phpexe_path' => !empty($_POST['phpexe_path']) ? $_POST['phpexe_path'] : ''
+ 'phpexe_path' => !empty($_POST['phpexe_path']) ? $_POST['phpexe_path'] : '',
]);
$this->redirect($url);
}
- $content = (string) file_get_contents(dirname(__FILE__) . '/libs/dc.phpcsfixer.rules.php');
+ $content = (string) file_get_contents(dirname(__FILE__) . '/phpcsfixer/phpcsfixer.rules.php');
return
'' .
@@ -89,11 +110,11 @@ class ImproveActionPhpcsfixer extends ImproveAction
'' . form::textarea('file_content', 120, 60, [
'default' => html::escapeHTML($content),
'class' => 'maximal',
- 'extra_html' => 'readonly="true"'
+ 'extra_html' => 'readonly="true"',
]) . '
' .
(
!self::$user_ui_colorsyntax ? '' :
- dcPage::jsLoad(dcPage::getPF('improve/inc/lib.improve.action.phpcsfixer.js')) .
+ dcPage::jsLoad(dcPage::getPF('improve/inc/module/phpcsfixer/phpcsfixer.improve.js')) .
dcPage::jsRunCodeMirror('editor', 'file_content', 'dotclear', self::$user_ui_colorsyntax_theme)
);
}
@@ -101,7 +122,7 @@ class ImproveActionPhpcsfixer extends ImproveAction
public function closeModule(): ?bool
{
$command = sprintf(
- '%sphp %s/libs/php-cs-fixer.phar fix %s --config=%s/libs/dc.phpcsfixer.rules.php --using-cache=no',
+ '%sphp %s/phpcsfixer/libs/php-cs-fixer.phar fix %s --config=%s/phpcsfixer/phpcsfixer.rules.php --using-cache=no',
$this->phpexe_path,
dirname(__FILE__),
$this->module['sroot'],
diff --git a/inc/libs/php-cs-fixer.phar b/inc/module/phpcsfixer/libs/php-cs-fixer.phar
similarity index 100%
rename from inc/libs/php-cs-fixer.phar
rename to inc/module/phpcsfixer/libs/php-cs-fixer.phar
diff --git a/inc/lib.improve.action.phpcsfixer.js b/inc/module/phpcsfixer/phpcsfixer.improve.js
similarity index 100%
rename from inc/lib.improve.action.phpcsfixer.js
rename to inc/module/phpcsfixer/phpcsfixer.improve.js
diff --git a/inc/libs/dc.phpcsfixer.rules.php b/inc/module/phpcsfixer/phpcsfixer.rules.php
similarity index 81%
rename from inc/libs/dc.phpcsfixer.rules.php
rename to inc/module/phpcsfixer/phpcsfixer.rules.php
index 059b618..b845a5f 100644
--- a/inc/libs/dc.phpcsfixer.rules.php
+++ b/inc/module/phpcsfixer/phpcsfixer.rules.php
@@ -1,23 +1,26 @@
exclude('node_modules')
->exclude('vendor')
->exclude('libs')
->in(__DIR__);
+/** @phpstan-ignore-next-line */
$config = new PhpCsFixer\Config();
+/* @phpstan-ignore-next-line */
return $config
->setRules([
'@PSR12' => true,
+ '@PHP74Migration' => true,
'array_indentation' => true,
- 'array_syntax' => ['syntax' => 'short'],
'binary_operator_spaces' => [
'default' => 'align_single_space_minimal',
'operators' => [
'=>' => 'align_single_space_minimal',
- ]
+ ],
],
'blank_line_before_statement' => true,
'braces' => ['allow_single_line_closure' => true],
@@ -33,15 +36,10 @@ return $config
'no_unused_imports' => true,
'no_useless_else' => true,
'no_useless_return' => true,
- 'no_whitespace_before_comma_in_array' => true,
- 'normalize_index_brace' => true,
'phpdoc_indent' => true,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
- 'return_type_declaration' => ['space_before' => 'none'],
'single_quote' => true,
- 'ternary_to_null_coalescing' => true,
- 'trailing_comma_in_multiline' => false,
'trim_array_spaces' => true,
])
->setFinder($finder);
diff --git a/inc/lib.improve.action.phpheader.php b/inc/module/phpheader.php
similarity index 91%
rename from inc/lib.improve.action.phpheader.php
rename to inc/module/phpheader.php
index e4f1614..90c3994 100644
--- a/inc/lib.improve.action.phpheader.php
+++ b/inc/module/phpheader.php
@@ -10,20 +10,37 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionPhpheader extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* clearbricks */
+use form;
+use html;
+
+/* php */
+use Exception;
+
+/**
+ * Improve action module php header
+ */
+class phpheader extends action
{
/** @var string Exemple of header */
private static $exemple = << Allowed bloc replacement */
private $bloc_wildcards = [
@@ -35,7 +52,7 @@ EOF;
'%user_cn%',
'%user_name%',
'%user_email%',
- '%user_url%'
+ '%user_url%',
];
/** @var array Allowed action for header */
@@ -58,7 +75,7 @@ EOF;
'description' => __('Add or remove phpdoc header bloc from php file'),
'priority' => 340,
'configurator' => true,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
$this->action_bloc = [
@@ -66,7 +83,7 @@ EOF;
__('Add bloc if it does not exist') => 'create',
__('Add and overwrite bloc') => 'overwrite',
__('Overwrite bloc only if it exists') => 'replace',
- __('Remove existing bloc header') => 'remove'
+ __('Remove existing bloc header') => 'remove',
];
$bloc_content = $this->getSetting('bloc_content');
@@ -87,7 +104,7 @@ EOF;
'bloc_action' => !empty($_POST['bloc_action']) ? $_POST['bloc_action'] : '',
'bloc_content' => !empty($_POST['bloc_content']) ? $_POST['bloc_content'] : '',
'remove_old' => !empty($_POST['remove_old']),
- 'exclude_locales' => !empty($_POST['exclude_locales'])
+ 'exclude_locales' => !empty($_POST['exclude_locales']),
]);
$this->redirect($url);
}
@@ -148,7 +165,7 @@ EOF;
$this->core->auth->getInfo('user_cn'),
$this->core->auth->getinfo('user_name'),
$this->core->auth->getInfo('user_email'),
- $this->core->auth->getInfo('user_url')
+ $this->core->auth->getInfo('user_url'),
],
(string) $bloc
)
diff --git a/inc/lib.improve.action.phpstan.php b/inc/module/phpstan.php
similarity index 90%
rename from inc/lib.improve.action.phpstan.php
rename to inc/module/phpstan.php
index 5d26cb8..55783bb 100644
--- a/inc/lib.improve.action.phpstan.php
+++ b/inc/module/phpstan.php
@@ -10,7 +10,28 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionPhpstan extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* dotclear */
+use dcPage;
+
+/* clearbricks */
+use html;
+use form;
+use path;
+
+/* php */
+use Exception;
+
+/**
+ * Improve action module PHPStan
+ */
+class phpstan extends action
{
/** @var boolean User pref to use colored synthax */
protected static $user_ui_colorsyntax = false;
@@ -35,7 +56,7 @@ class ImproveActionPhpstan extends ImproveAction
'description' => __('Analyse php code using PHPStan'),
'priority' => 910,
'configurator' => true,
- 'types' => ['plugin']
+ 'types' => ['plugin'],
]);
$this->getPhpPath();
@@ -74,11 +95,11 @@ class ImproveActionPhpstan extends ImproveAction
'phpexe_path' => (!empty($_POST['phpexe_path']) ? $_POST['phpexe_path'] : ''),
'run_level' => (int) $_POST['run_level'],
'ignored_vars' => (!empty($_POST['ignored_vars']) ? $_POST['ignored_vars'] : ''),
- 'split_report' => !empty($_POST['split_report'])
+ 'split_report' => !empty($_POST['split_report']),
]);
$this->redirect($url);
}
- $content = (string) file_get_contents(dirname(__FILE__) . '/libs/dc.phpstan.rules.conf');
+ $content = (string) file_get_contents(dirname(__FILE__) . '/phpstan/phpstan.rules.conf');
return
'' . __('You must enable improve details to view analyse results !') . '
' .
@@ -108,11 +129,11 @@ class ImproveActionPhpstan extends ImproveAction
'' . form::textarea('file_content', 120, 14, [
'default' => html::escapeHTML($content),
'class' => 'maximal',
- 'extra_html' => 'readonly="true"'
+ 'extra_html' => 'readonly="true"',
]) . '
' .
(
!self::$user_ui_colorsyntax ? '' :
- dcPage::jsLoad(dcPage::getPF('improve/inc/lib.improve.action.phpstan.js')) .
+ dcPage::jsLoad(dcPage::getPF('improved/inc/module/phpstan/phpstan.improve.js')) .
dcPage::jsRunCodeMirror('editor', 'file_content', 'dotclear', self::$user_ui_colorsyntax_theme)
);
}
@@ -158,7 +179,7 @@ class ImproveActionPhpstan extends ImproveAction
}
$command = sprintf(
- '%sphp %s/libs/phpstan.phar analyse ' . $path . '--configuration=%s',
+ '%sphp %s/phpstan/libs/phpstan.phar analyse ' . $path . '--configuration=%s',
$this->phpexe_path,
dirname(__FILE__),
DC_VAR . '/phpstan.neon'
@@ -179,6 +200,7 @@ class ImproveActionPhpstan extends ImproveAction
return true;
} catch (Exception $e) {
$this->setError(__('Failed to run phpstan'));
+ pdump($e);
return false;
}
@@ -210,15 +232,15 @@ class ImproveActionPhpstan extends ImproveAction
'%LEVEL%',
'%MODULE_ROOT%',
'%DC_ROOT%',
- '%BOOTSTRAP_ROOT%'
+ '%BOOTSTRAP_ROOT%',
],
[
$this->run_level,
$this->module['sroot'],
DC_ROOT,
- dirname(__FILE__) . '/libs/'
+ dirname(__FILE__) . '/phpstan',
],
- (string) file_get_contents(dirname(__FILE__) . '/libs/dc.phpstan.rules.conf')
+ (string) file_get_contents(dirname(__FILE__) . '/phpstan/phpstan.rules.conf')
);
$ignored = explode(';', $this->ignored_vars);
diff --git a/inc/libs/phpstan.phar b/inc/module/phpstan/libs/phpstan.phar
similarity index 96%
rename from inc/libs/phpstan.phar
rename to inc/module/phpstan/libs/phpstan.phar
index 418c8d7..306020e 100644
Binary files a/inc/libs/phpstan.phar and b/inc/module/phpstan/libs/phpstan.phar differ
diff --git a/inc/libs/dc.phpstan.bootstrap.php b/inc/module/phpstan/phpstan.bootstrap.php
similarity index 100%
rename from inc/libs/dc.phpstan.bootstrap.php
rename to inc/module/phpstan/phpstan.bootstrap.php
diff --git a/inc/lib.improve.action.phpstan.js b/inc/module/phpstan/phpstan.improve.js
similarity index 100%
rename from inc/lib.improve.action.phpstan.js
rename to inc/module/phpstan/phpstan.improve.js
diff --git a/inc/libs/dc.phpstan.rules.conf b/inc/module/phpstan/phpstan.rules.conf
similarity index 98%
rename from inc/libs/dc.phpstan.rules.conf
rename to inc/module/phpstan/phpstan.rules.conf
index 75b95f3..a45cf6e 100644
--- a/inc/libs/dc.phpstan.rules.conf
+++ b/inc/module/phpstan/phpstan.rules.conf
@@ -14,7 +14,7 @@ parameters:
- %MODULE_ROOT%/*/libs/*
bootstrapFiles:
- - %BOOTSTRAP_ROOT%dc.phpstan.bootstrap.php
+ - %BOOTSTRAP_ROOT%/phpstan.bootstrap.php
fileExtensions:
- php
diff --git a/inc/module/tab.php b/inc/module/tab.php
new file mode 100644
index 0000000..ea8dfa8
--- /dev/null
+++ b/inc/module/tab.php
@@ -0,0 +1,56 @@
+setProperties([
+ 'id' => 'tab',
+ 'name' => __('Tabulations'),
+ 'description' => __('Replace tabulation by four space in php files'),
+ 'priority' => 820,
+ 'types' => ['plugin', 'theme'],
+ ]);
+
+ return true;
+ }
+
+ public function readFile(&$content): ?bool
+ {
+ if (!in_array($this->path_extension, ['php', 'md'])) {
+ return null;
+ }
+ $clean = preg_replace('/(\t)/', ' ', $content);// . "\n";
+ if ($content != $clean) {
+ $this->setSuccess(__('Replace tabulation by spaces'));
+ $content = $clean;
+ }
+
+ return true;
+ }
+
+ public function isConfigured(): bool
+ {
+ return true;
+ }
+}
diff --git a/inc/lib.improve.action.zip.php b/inc/module/zip.php
similarity index 95%
rename from inc/lib.improve.action.zip.php
rename to inc/module/zip.php
index 7a16fdd..0593b66 100644
--- a/inc/lib.improve.action.zip.php
+++ b/inc/module/zip.php
@@ -10,7 +10,23 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
-class ImproveActionZip extends ImproveAction
+declare(strict_types=1);
+
+namespace plugins\improve\module;
+
+/* improve */
+use plugins\improve\action;
+
+/* clearbricks */
+use form;
+use path;
+use files;
+use fileZip;
+
+/**
+ * Improve action module zip
+ */
+class zip extends action
{
/** @var array List of excluded file pattern */
public static $exclude = [
@@ -23,7 +39,7 @@ class ImproveActionZip extends ImproveAction
'CVS',
'.DS_Store',
'Thumbs.db',
- '_disabled'
+ '_disabled',
];
/** @var array Replacement wildcards */
@@ -32,7 +48,7 @@ class ImproveActionZip extends ImproveAction
'%id%',
'%version%',
'%author%',
- '%time%'
+ '%time%',
];
/** @var string Settings Excluded files */
@@ -52,7 +68,7 @@ class ImproveActionZip extends ImproveAction
'description' => __('Compress module into a ready to install package'),
'priority' => 980,
'configurator' => true,
- 'types' => ['plugin', 'theme']
+ 'types' => ['plugin', 'theme'],
]);
$pack_excludefiles = $this->getSetting('pack_excludefiles');
@@ -81,7 +97,7 @@ class ImproveActionZip extends ImproveAction
'secondpack_filename' => !empty($_POST['secondpack_filename']) ? $_POST['secondpack_filename'] : '',
'pack_overwrite' => !empty($_POST['pack_overwrite']),
'pack_excludefiles' => !empty($_POST['pack_excludefiles']) ? $_POST['pack_excludefiles'] : '',
- 'pack_nocomment' => !empty($_POST['pack_nocomment'])
+ 'pack_nocomment' => !empty($_POST['pack_nocomment']),
]);
$this->redirect($url);
}
@@ -143,7 +159,7 @@ class ImproveActionZip extends ImproveAction
);
$this->setSuccess(sprintf(__('Prepare excluded files "%s"'), implode(', ', $exclude)));
if (!empty($this->getSetting('pack_nocomment'))) {
- ImproveZipFileZip::$remove_comment = true;
+ zipFileZip::$remove_comment = true;
$this->setSuccess(__('Prepare comment removal'));
}
if (!empty($this->getSetting('pack_filename'))) {
@@ -165,7 +181,7 @@ class ImproveActionZip extends ImproveAction
$this->module['id'],
$this->module['version'],
$this->module['author'],
- time()
+ time(),
],
$file
);
@@ -186,7 +202,7 @@ class ImproveActionZip extends ImproveAction
}
@set_time_limit(300);
$fp = fopen($path, 'wb');
- $zip = new ImproveZipFileZip($fp);
+ $zip = new zipFileZip($fp);
foreach ($exclude as $e) {
$e = '#(^|/)(' . str_replace(
['.', '*'],
@@ -208,7 +224,7 @@ class ImproveActionZip extends ImproveAction
}
}
-class ImproveZipFileZip extends fileZip
+class zipFileZip extends fileZip
{
/** @var boolean Should remove comments from files */
public static $remove_comment = false;
diff --git a/index.php b/index.php
index 8831c13..576f468 100644
--- a/index.php
+++ b/index.php
@@ -10,236 +10,320 @@
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
+declare(strict_types=1);
+
+namespace plugins\improve;
+
if (!defined('DC_CONTEXT_ADMIN')) {
return;
}
-dcPage::checkSuper();
+/* dotclear */
+use dcCore;
+use dcPage;
+use dcThemes;
+use dcUtils;
-$improve = new Improve($core);
+/* clearbricks */
+use html;
+use form;
-$show_filters = false;
-$type = $_REQUEST['type'] ?? 'plugin';
+/* php */
+use Exception;
-$preferences = @unserialize($core->blog->settings->improve->preferences);
-if (!is_array($preferences)) {
- $preferences = [];
-}
-$preferences = array_merge(['plugin' => [], 'theme' => []], $preferences);
+/**
+ * Improve page class
+ *
+ * Display page and configure modules
+ * and launch action.
+ */
+class index
+{
+ /** @var dcCore $core dcCore instance */
+ private $core = null;
+ /** @var improve $improve improve core instance */
+ private $improve = null;
+ /** @var string $type Current module(s) type */
+ private $type = 'plugin';
+ /** @var string $module Current module id */
+ private $module = '-';
+ /** @var action|null $action Current action module */
+ private $action = null;
-if (!empty($_POST['save_preferences'])) {
- $preferences[$type] = [];
- if (!empty($_POST['actions'])) {
- foreach ($improve->modules() as $action) {
- if (in_array($type, $action->types()) && in_array($action->id(), $_POST['actions'])) {
- $preferences[$type][] = $action->id();
- }
+ public function __construct(dcCore $core)
+ {
+ dcPage::checkSuper();
+
+ $this->core = $core;
+ $this->improve = new improve($core);
+ $this->type = $this->getType();
+ $this->module = $this->getModule();
+ $this->action = $this->getAction();
+
+ $this->doAction();
+ $this->displayPage();
+ }
+
+ private function getType(): string
+ {
+ return $_REQUEST['type'] ?? 'plugin';
+ }
+
+ private function getModule(): string
+ {
+ $module = $_REQUEST['module'] ?? '';
+ if (!in_array($module, $this->comboModules())) {
+ $module = '-';
}
+
+ return $module;
}
- $core->blog->settings->improve->put('preferences', serialize($preferences), 'string', null, true, true);
- dcPage::addSuccessNotice(__('Configuration successfully updated'));
-}
-$allow_distrib = (bool) $core->blog->settings->improve->allow_distrib;
-$official = [
- 'plugin' => explode(',', DC_DISTRIB_PLUGINS),
- 'theme' => explode(',', DC_DISTRIB_THEMES)
-];
-
-if (!isset($core->themes)) {
- $core->themes = new dcThemes($core);
- $core->themes->loadModules($core->blog->themes_path, null);
-}
-
-$combo_modules = [];
-$modules = $type == 'plugin' ? $core->plugins->getModules() : $core->themes->getModules();
-foreach ($modules as $id => $m) {
- if (!$m['root_writable'] || !$allow_distrib && in_array($id, $official[$type])) {
- continue;
+ private function getAction(): ?action
+ {
+ return empty($_REQUEST['config']) ? null : $this->improve->module($_REQUEST['config']);
}
- $combo_modules[__($m['name'])] = $id;
-}
-dcUtils::lexicalKeySort($combo_modules);
-$combo_modules = array_merge([__('Select a module') => '-'], $combo_modules);
-$module = $_REQUEST['module'] ?? '';
-if (!in_array($module, $combo_modules)) {
- $module = '-';
-}
-
-if (!empty($_POST['fix'])) {
- if (empty($_POST['actions'])) {
- dcPage::addWarningNotice(__('No action selected'));
- } elseif ($module == '-') {
- dcPage::addWarningNotice(__('No module selected'));
- } else {
+ private function getPreference(): array
+ {
try {
- $time = $improve->fixModule(
- $type,
- $module,
- $type == 'plugin' ? $core->plugins->getModules($module) : $core->themes->getModules($module),
- $_POST['actions']
- );
- $log_id = $improve->writeLogs();
- $core->blog->triggerBlog();
-
- if ($improve->hasLog('error')) {
- $notice = ['type' => 'error', 'msg' => __('Fix of "%s" complete in %s secondes with errors')];
- } elseif ($improve->hasLog('warning')) {
- $notice = ['type' => 'warning', 'msg' => __('Fix of "%s" complete in %s secondes with warnings')];
- } elseif ($improve->hasLog('success')) {
- $notice = ['type' => 'success', 'msg' => __('Fix of "%s" complete in %s secondes')];
- } else {
- $notice = ['type' => 'success', 'msg' => __('Fix of "%s" complete in %s secondes without messages')];
+ if (!empty($this->type)) {
+ $preferences = unserialize($this->core->blog->settings->improve->preferences);
+ if (is_array($preferences)) {
+ return array_key_exists($this->type, $preferences) ? $preferences[$this->type] : [];
+ }
}
- dcPage::addNotice($notice['type'], sprintf($notice['msg'], $module, $time));
-
- $core->adminurl->redirect('admin.plugin.improve', ['type' => $type, 'module' => $module, 'upd' => $log_id]);
} catch (Exception $e) {
- $core->error->add($e->getMessage());
+ }
+
+ return [];
+ }
+
+ private function setPreferences(): void
+ {
+ if (!empty($_POST['save_preferences'])) {
+ $preferences[$this->type] = [];
+ if (!empty($_POST['actions'])) {
+ foreach ($this->improve->modules() as $action) {
+ if (in_array($this->type, $action->types()) && in_array($action->id(), $_POST['actions'])) {
+ $preferences[$this->type][] = $action->id();
+ }
+ }
+ }
+ $this->core->blog->settings->improve->put('preferences', serialize($preferences), 'string', null, true, true);
+ dcPage::addSuccessNotice(__('Configuration successfully updated'));
}
}
-}
-$action = null;
-$header = '';
-$breadcrumb = [];
-if (!empty($_REQUEST['config'])) {
- $breadcrumb = [
- __('Configure module') => ''
- ];
- if (null !== ($action = $improve->module($_REQUEST['config']))) {
- $header = $action->header();
- }
-} else {
- $breadcrumb[$type == 'theme' ? __('Themes actions') : __('Plugins actions')] = '';
-}
+ private function comboModules(): array
+ {
+ $allow_distrib = (bool) $this->core->blog->settings->improve->allow_distrib;
+ $official = [
+ 'plugin' => explode(',', DC_DISTRIB_PLUGINS),
+ 'theme' => explode(',', DC_DISTRIB_THEMES),
+ ];
-# display header
-echo '' . __('improve') . ' ' .
-dcPage::jsLoad(dcPage::getPF('improve/js/index.js')) .
-$header .
-'' .
-dcPage::breadcrumb(array_merge([
- __('Plugins') => '',
- __('improve') => ''
-], $breadcrumb)) .
-dcPage::notices();
+ if (!isset($this->core->themes)) {
+ $this->core->themes = new dcThemes($this->core);
+ $this->core->themes->loadModules($this->core->blog->themes_path, null);
+ }
-# Menu list
-if (empty($_REQUEST['config'])) {
- echo
- '';
-}
-
-if (!empty($_REQUEST['config'])) {
- $back_url = $_REQUEST['redir'] ?? $core->adminurl->get('admin.plugin.improve', ['type' => $type]);
-
- if (null !== $action) {
- $redir = $_REQUEST['redir'] ?? $core->adminurl->get('admin.plugin.improve', ['type' => $type, 'config' => $action->id()]);
- $res = $action->configure($redir);
-
- echo '
- ' . sprintf(__('Configure module "%s"'), $action->name()) . '
- ' . __('Back') . '
- ' . html::escapeHTML($action->description()) . '
- ';
- } else {
- echo '
- ' . __('Unknow module') . '
- ' . __('Back') . '
';
- }
-} else {
- if (count($combo_modules) == 1) {
- echo '' . __('No module to manage') . '
';
- } else {
- echo '';
+ echo '';
+ }
- if (!empty($_REQUEST['upd']) && !$core->blog->settings->improve->nodetails) {
- $logs = $improve->parseLogs($_REQUEST['upd']);
+ private function displayConfigurator(): void
+ {
+ $back_url = $_REQUEST['redir'] ?? $this->core->adminurl->get('admin.plugin.improve', ['type' => $this->type]);
- if (!empty($logs)) {
- echo '' . __('Details') . ' ';
- foreach ($logs as $path => $types) {
- echo '
' . $path . ' ';
- foreach ($types as $type => $tools) {
- echo '
';
- foreach ($tools as $tool => $msgs) {
- $a = $improve->module($tool);
- echo '' . ($a !== null ? $a->name() : 'unknow') . '';
- foreach ($msgs as $msg) {
- echo '' . $msg . ' ';
- }
- echo ' ';
- }
- echo ' ';
- }
- echo '';
+ if (null === $this->action) {
+ echo '
+
' . __('Unknow module') . '
+
' . __('Back') . '
';
+ } else {
+ $redir = $_REQUEST['redir'] ?? $this->core->adminurl->get('admin.plugin.improve', ['type' => $this->type, 'config' => $this->action->id()]);
+ $res = $this->action->configure($redir);
+
+ echo '
+
' . sprintf(__('Configure module "%s"'), $this->action->name()) . '
+
' . __('Back') . '
+
' . html::escapeHTML($this->action->description()) . '
+
';
+ }
+ }
+
+ private function displayActions(): void
+ {
+ echo
+ '';
+
+ $combo_modules = $this->comboModules();
+ if (count($combo_modules) == 1) {
+ echo '
' . __('No module to manage') . '
';
+ } else {
+ echo '
';
+
+ if (!empty($_REQUEST['upd']) && !$this->core->blog->settings->improve->nodetails) {
+ $logs = $this->improve->parseLogs((int) $_REQUEST['upd']);
+
+ if (!empty($logs)) {
+ echo '
' . __('Details') . ' ';
+ foreach ($logs as $path => $types) {
+ echo '
' . $path . ' ';
+ foreach ($types as $type => $tools) {
+ echo '
';
+ foreach ($tools as $tool => $msgs) {
+ $a = $this->improve->module($tool);
+ if (null !== $a) {
+ echo '' . $a->name() . '';
+ foreach ($msgs as $msg) {
+ echo '' . $msg . ' ';
+ }
+ }
+ echo ' ';
+ }
+ echo ' ';
+ }
+ echo '';
+ }
+ echo '
';
}
- echo '