luxick/luxtools-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Change project name to filetools

Browse Source
This commit is contained in:
luxick
2026-01-05 10:37:51 +01:00
parent a3558c470e
commit fe8d0bbffb
15 changed files with 77 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Crawler.php
View File

@@ -1,6 +1,6 @@
<?php
namespace dokuwiki\plugin\filelistplus;
namespace dokuwiki\plugin\filetools;
class Crawler
{

8
Output.php
View File

@@ -1,6 +1,6 @@
<?php
namespace dokuwiki\plugin\filelistplus;
namespace dokuwiki\plugin\filetools;
class Output
{
@@ -28,7 +28,7 @@ class Output
public function renderAsList($params)
{
if ($this->renderer instanceof \Doku_Renderer_xhtml) {
$this->renderer->doc .= '<div class="filelistplus-plugin">';
$this->renderer->doc .= '<div class="filetools-plugin">';
}
$this->renderListItems($this->files, $params);
@@ -46,7 +46,7 @@ class Output
public function renderAsTable($params)
{
if ($this->renderer instanceof \Doku_Renderer_xhtml) {
$this->renderer->doc .= '<div class="filelistplus-plugin">';
$this->renderer->doc .= '<div class="filetools-plugin">';
}
$items = $this->flattenResultTree($this->files);
@@ -277,7 +277,7 @@ class Output
protected function getLang($key)
{
$syntax = plugin_load('syntax', 'filelistplus');
$syntax = plugin_load('syntax', 'filetools');
return $syntax->getLang($key);
}
}

4
Path.php
View File

@@ -1,6 +1,6 @@
<?php
namespace dokuwiki\plugin\filelistplus;
namespace dokuwiki\plugin\filetools;
class Path
{
@@ -60,7 +60,7 @@ class Path
$lastRoot = $line;
$paths[$line] = [
'root' => $line,
'web' => DOKU_BASE . 'lib/plugins/filelistplus/file.php?root=' . rawurlencode($line) . '&file=',
'web' => DOKU_BASE . 'lib/plugins/filetools/file.php?root=' . rawurlencode($line) . '&file=',
];
}
}

9
README
View File

@@ -1,14 +1,17 @@
filelistplus plugin for DokuWiki
File Tools plugin for DokuWiki
Lists files matching a given glob pattern.
All documentation for this plugin can be found at
https://www.dokuwiki.org/plugin:filelistplus
https://www.dokuwiki.org/plugin:filetools
If you install this plugin manually, make sure it is installed in
lib/plugins/filelistplus/ - if the folder is called different it
lib/plugins/filetools/ - if the folder is called different it
will not work!
Syntax:
{{files>...}}
Please refer to http://www.dokuwiki.org/extensions for additional info
on how to install extensions in DokuWiki.

14
_test/GeneralTest.php
View File

@@ -1,13 +1,13 @@
<?php
namespace dokuwiki\plugin\filelistplus\test;
namespace dokuwiki\plugin\filetools\test;
use DokuWikiTest;
/**
* General tests for the filelistplus plugin
* General tests for the filetools plugin
*
* @group plugin_filelistplus
* @group plugin_filetools
* @group plugins
*/
class GeneralTest extends DokuWikiTest
@@ -31,7 +31,7 @@ class GeneralTest extends DokuWikiTest
$this->assertArrayHasKey('desc', $info);
$this->assertArrayHasKey('url', $info);
$this->assertEquals('filelistplus', $info['base']);
$this->assertEquals('filetools', $info['base']);
$this->assertRegExp('/^https?:\/\//', $info['url']);
$this->assertTrue(mail_isvalid($info['email']));
$this->assertRegExp('/^\d\d\d\d-\d\d-\d\d$/', $info['date']);
@@ -61,7 +61,7 @@ class GeneralTest extends DokuWikiTest
$this->assertEquals(
gettype($conf),
gettype($meta),
'Both ' . DOKU_PLUGIN . 'filelistplus/conf/default.php and ' . DOKU_PLUGIN . 'filelistplus/conf/metadata.php have to exist and contain the same keys.'
'Both ' . DOKU_PLUGIN . 'filetools/conf/default.php and ' . DOKU_PLUGIN . 'filetools/conf/metadata.php have to exist and contain the same keys.'
);
if ($conf !== null && $meta !== null) {
@@ -69,7 +69,7 @@ class GeneralTest extends DokuWikiTest
$this->assertArrayHasKey(
$key,
$meta,
'Key $meta[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'filelistplus/conf/metadata.php'
'Key $meta[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'filetools/conf/metadata.php'
);
}
@@ -77,7 +77,7 @@ class GeneralTest extends DokuWikiTest
$this->assertArrayHasKey(
$key,
$conf,
'Key $conf[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'filelistplus/conf/default.php'
'Key $conf[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'filetools/conf/default.php'
);
}
}

14
_test/PathTest.php
View File

@@ -1,14 +1,14 @@
<?php
namespace dokuwiki\plugin\filelistplus\test;
namespace dokuwiki\plugin\filetools\test;
use dokuwiki\plugin\filelistplus\Path;
use dokuwiki\plugin\filetools\Path;
use DokuWikiTest;
/**
* Path related tests for the filelistplus plugin
* Path related tests for the filetools plugin
*
* @group plugin_filelistplus
* @group plugin_filetools
* @group plugins
*/
class PathTest extends DokuWikiTest
@@ -40,15 +40,15 @@ EOT
$expect = [
'C:/xampp/htdocs/wiki/' => [
'root' => 'C:/xampp/htdocs/wiki/',
'web' => '/lib/plugins/filelistplus/file.php?root=C%3A%2Fxampp%2Fhtdocs%2Fwiki%2F&file=',
'web' => '/lib/plugins/filetools/file.php?root=C%3A%2Fxampp%2Fhtdocs%2Fwiki%2F&file=',
],
'\\\\server/share/path/' => [
'root' => '\\\\server/share/path/',
'web' => '/lib/plugins/filelistplus/file.php?root=%5C%5Cserver%2Fshare%2Fpath%2F&file=',
'web' => '/lib/plugins/filetools/file.php?root=%5C%5Cserver%2Fshare%2Fpath%2F&file=',
],
'/linux/file/path/' => [
'root' => '/linux/file/path/',
'web' => '/lib/plugins/filelistplus/file.php?root=%2Flinux%2Ffile%2Fpath%2F&file=',
'web' => '/lib/plugins/filetools/file.php?root=%2Flinux%2Ffile%2Fpath%2F&file=',
],
'/linux/another/path/' => [
'root' => '/linux/another/path/',

68
_test/SyntaxTest.php
View File

@@ -1,35 +1,35 @@
<?php
namespace dokuwiki\plugin\filelistplus\test;
namespace dokuwiki\plugin\filetools\test;
use DokuWikiTest;
use DOMWrap\Document;
/**
* Tests for the filelistplus plugin.
* Tests for the filetools plugin.
*
* These test assume that the directory filelistplus has the following content:
* These test assume that the directory filetools has the following content:
* - exampledir (directory)
* - example2.txt (text file)
* - example.txt (text file)
* - exampleimage.png (image file)
*
* @group plugin_filelistplus
* @group plugin_filetools
* @group plugins
*/
class plugin_filelistplus_test extends DokuWikiTest
class plugin_filetools_test extends DokuWikiTest
{
public function setUp(): void
{
global $conf;
$this->pluginsEnabled[] = 'filelistplus';
$this->pluginsEnabled[] = 'filetools';
parent::setUp();
// Setup config so that access to the TMP directory will be allowed
$conf ['plugin']['filelistplus']['paths'] = TMP_DIR . '/filelistdata/' . "\n" . 'W> http://localhost/';
$conf ['plugin']['filetools']['paths'] = TMP_DIR . '/filelistdata/' . "\n" . 'W> http://localhost/';
}
@@ -76,7 +76,7 @@ class plugin_filelistplus_test extends DokuWikiTest
global $conf;
// Render filelist
$instructions = p_get_instructions('{{filelistplus>' . TMP_DIR . '/filelistdata/*&style=list&direct=1}}');
$instructions = p_get_instructions('{{files>' . TMP_DIR . '/filelistdata/*&style=list&direct=1}}');
$xhtml = p_render('xhtml', $instructions, $info);
// We should find:
@@ -94,7 +94,7 @@ class plugin_filelistplus_test extends DokuWikiTest
public function test_recursive()
{
// Render filelist
$instructions = p_get_instructions('{{filelistplus>' . TMP_DIR . '/filelistdata/*&style=list&direct=1&recursive=1}}');
$instructions = p_get_instructions('{{files>' . TMP_DIR . '/filelistdata/*&style=list&direct=1&recursive=1}}');
$xhtml = p_render('xhtml', $instructions, $info);
// We should find:
@@ -119,21 +119,21 @@ class plugin_filelistplus_test extends DokuWikiTest
public function testUnorderedList()
{
// Render filelist
$instructions = p_get_instructions('{{filelistplus>' . TMP_DIR . '/filelistdata/*&style=list&direct=1&recursive=1}}');
$instructions = p_get_instructions('{{files>' . TMP_DIR . '/filelistdata/*&style=list&direct=1&recursive=1}}');
$xhtml = p_render('xhtml', $instructions, $info);
$doc = new Document();
$doc->html($xhtml);
$structure = [
'div.filelistplus-plugin' => 1,
'div.filelistplus-plugin > ul' => 1,
'div.filelistplus-plugin > ul > li' => 3,
'div.filelistplus-plugin > ul > li:nth-child(1)' => 1,
'div.filelistplus-plugin > ul > li:nth-child(1) a' => 'example.txt',
'div.filelistplus-plugin > ul > li:nth-child(2) ul' => 1,
'div.filelistplus-plugin > ul > li:nth-child(2) ul > li' => 1,
'div.filelistplus-plugin > ul > li:nth-child(2) ul > li a' => 'example2.txt',
'div.filetools-plugin' => 1,
'div.filetools-plugin > ul' => 1,
'div.filetools-plugin > ul > li' => 3,
'div.filetools-plugin > ul > li:nth-child(1)' => 1,
'div.filetools-plugin > ul > li:nth-child(1) a' => 'example.txt',
'div.filetools-plugin > ul > li:nth-child(2) ul' => 1,
'div.filetools-plugin > ul > li:nth-child(2) ul > li' => 1,
'div.filetools-plugin > ul > li:nth-child(2) ul > li a' => 'example2.txt',
];
$this->structureCheck($doc, $structure);
@@ -146,21 +146,21 @@ class plugin_filelistplus_test extends DokuWikiTest
public function testOrderedList()
{
// Render filelist
$instructions = p_get_instructions('{{filelistplus>' . TMP_DIR . '/filelistdata/*&style=olist&direct=1&recursive=1}}');
$instructions = p_get_instructions('{{files>' . TMP_DIR . '/filelistdata/*&style=olist&direct=1&recursive=1}}');
$xhtml = p_render('xhtml', $instructions, $info);
$doc = new Document();
$doc->html($xhtml);
$structure = [
'div.filelistplus-plugin' => 1,
'div.filelistplus-plugin > ol' => 1,
'div.filelistplus-plugin > ol > li' => 3,
'div.filelistplus-plugin > ol > li:nth-child(1)' => 1,
'div.filelistplus-plugin > ol > li:nth-child(1) a' => 'example.txt',
'div.filelistplus-plugin > ol > li:nth-child(2) ol' => 1,
'div.filelistplus-plugin > ol > li:nth-child(2) ol > li' => 1,
'div.filelistplus-plugin > ol > li:nth-child(2) ol > li a' => 'example2.txt',
'div.filetools-plugin' => 1,
'div.filetools-plugin > ol' => 1,
'div.filetools-plugin > ol > li' => 3,
'div.filetools-plugin > ol > li:nth-child(1)' => 1,
'div.filetools-plugin > ol > li:nth-child(1) a' => 'example.txt',
'div.filetools-plugin > ol > li:nth-child(2) ol' => 1,
'div.filetools-plugin > ol > li:nth-child(2) ol > li' => 1,
'div.filetools-plugin > ol > li:nth-child(2) ol > li a' => 'example2.txt',
];
$this->structureCheck($doc, $structure);
@@ -175,19 +175,19 @@ class plugin_filelistplus_test extends DokuWikiTest
global $conf;
// Render filelist
$instructions = p_get_instructions('{{filelistplus>' . TMP_DIR . '/filelistdata/*&style=table&direct=1&recursive=1}}');
$instructions = p_get_instructions('{{files>' . TMP_DIR . '/filelistdata/*&style=table&direct=1&recursive=1}}');
$xhtml = p_render('xhtml', $instructions, $info);
$doc = new Document();
$doc->html($xhtml);
$structure = [
'div.filelistplus-plugin' => 1,
'div.filelistplus-plugin table' => 1,
'div.filelistplus-plugin table > tbody > tr' => 3,
'div.filelistplus-plugin table > tbody > tr:nth-child(1) a' => 'example.txt',
'div.filelistplus-plugin table > tbody > tr:nth-child(2) a' => 'exampledir/example2.txt',
'div.filelistplus-plugin table > tbody > tr:nth-child(3) a' => 'exampleimage.png',
'div.filetools-plugin' => 1,
'div.filetools-plugin table' => 1,
'div.filetools-plugin table > tbody > tr' => 3,
'div.filetools-plugin table > tbody > tr:nth-child(1) a' => 'example.txt',
'div.filetools-plugin table > tbody > tr:nth-child(2) a' => 'exampledir/example2.txt',
'div.filetools-plugin table > tbody > tr:nth-child(3) a' => 'exampleimage.png',
];
$this->structureCheck($doc, $structure);

2
conf/default.php
View File

@@ -1,7 +1,7 @@
<?php
/**
* Options for the filelistplus plugin
* Options for the filetools plugin
*/
$conf['paths'] = '';

2
conf/metadata.php
View File

@@ -2,7 +2,7 @@
/**
* Metadata for configuration manager plugin
* Additions for the filelistplus plugin
* Additions for the filetools plugin
*
* @author Gina Haeussge <osd@foosel.net>
*/

4
file.php
View File

@@ -2,7 +2,7 @@
// phpcs:disable PSR1.Files.SideEffects.FoundWithSymbols
use dokuwiki\plugin\filelistplus\Path;
use dokuwiki\plugin\filetools\Path;
if (!defined('DOKU_INC')) define('DOKU_INC', __DIR__ . '/../../../');
if (!defined('NOSESSION')) define('NOSESSION', true); // we do not use a session or authentication here (better caching)
@@ -11,7 +11,7 @@ require_once(DOKU_INC . 'inc/init.php');
global $INPUT;
$syntax = plugin_load('syntax', 'filelistplus');
$syntax = plugin_load('syntax', 'filetools');
if (!$syntax) die('plugin disabled?');
$pathUtil = new Path($syntax->getConf('paths'));

2
lang/de/settings.php
View File

@@ -1,3 +1,3 @@
<?php
$lang['allow_in_comments'] = 'Filelistplus-Syntax in Kommentaren erlauben.';
$lang['allow_in_comments'] = 'Files-Syntax in Kommentaren erlauben.';

2
lang/en/settings.php
View File

@@ -1,5 +1,5 @@
<?php
$lang['allow_in_comments'] = 'Whether to allow the filelistplus syntax to be used in comments.';
$lang['allow_in_comments'] = 'Whether to allow the files syntax to be used in comments.';
$lang['defaults'] = 'Default options. Use the same syntax as in inline configuration';
$lang['extensions'] = 'Comma-separated list of allowed file extensions to list';

2
lang/nl/settings.php
View File

@@ -4,6 +4,6 @@
*
* @author Mark C. Prins <mprins@users.sf.net>
*/
$lang['allow_in_comments'] = 'Of de filelistplus syntax toegestaan is voor gebruik in commentaar.';
$lang['allow_in_comments'] = 'Of de files syntax toegestaan is voor gebruik in commentaar.';
$lang['defaults'] = 'Default options. Gebruik dezelfde syntax als de inline configuratie.';
$lang['extensions'] = 'Komma-gescheiden lijst van toegestane bestandsextensies voor de lijst.';

6
plugin.info.txt
View File

@@ -1,7 +1,7 @@
base filelistplus
base filetools
author Gina Häußge, Dokufreaks, luxick
email dokuwiki@luxick.de
date 2026-01-05
name Filelist Plus Plugin
name File Tools
desc Lists files matching a given glob pattern.
url https://www.dokuwiki.org/plugin:filelistplus
url https://www.dokuwiki.org/plugin:filetools

12
syntax.php
View File

@@ -1,9 +1,9 @@
<?php
use dokuwiki\Extension\SyntaxPlugin;
use dokuwiki\plugin\filelistplus\Crawler;
use dokuwiki\plugin\filelistplus\Output;
use dokuwiki\plugin\filelistplus\Path;
use dokuwiki\plugin\filetools\Crawler;
use dokuwiki\plugin\filetools\Output;
use dokuwiki\plugin\filetools\Path;
/**
* Filelist Plus Plugin: Lists files matching a given glob pattern.
@@ -11,7 +11,7 @@ use dokuwiki\plugin\filelistplus\Path;
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Gina Haeussge <osd@foosel.net>
*/
class syntax_plugin_filelistplus extends SyntaxPlugin
class syntax_plugin_filetools extends SyntaxPlugin
{
/** @inheritdoc */
public function getType()
@@ -34,7 +34,7 @@ class syntax_plugin_filelistplus extends SyntaxPlugin
/** @inheritdoc */
public function connectTo($mode)
{
$this->Lexer->addSpecialPattern('\{\{filelistplus>.+?\}\}', $mode, 'plugin_filelistplus');
$this->Lexer->addSpecialPattern('\{\{files>.+?\}\}', $mode, 'plugin_filetools');
}
/** @inheritdoc */
@@ -47,7 +47,7 @@ class syntax_plugin_filelistplus extends SyntaxPlugin
return false;
}
$match = substr($match, strlen('{{filelistplus>'), -2);
$match = substr($match, strlen('{{files>'), -2);
[$path, $flags] = explode('&', $match, 2);
// load default config options