initial automatic cleanup

This commit is contained in:
Andreas Gohr
2024-02-26 11:58:11 +01:00
parent 31b4eb67ba
commit 1c9be8254b
8 changed files with 653 additions and 238 deletions

View File

@@ -1,4 +1,7 @@
<?php
use dokuwiki\Extension\SyntaxPlugin;
/**
* Filelist Plugin: Lists files matching a given glob pattern.
*
@@ -13,81 +16,72 @@ define('DOKU_PLUGIN_FILELIST_OUTSIDEJAIL', -2);
* All DokuWiki plugins to extend the parser/rendering mechanism
* need to inherit from this class
*/
class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
class syntax_plugin_filelist extends SyntaxPlugin
{
public $mediadir;
public $is_odt_export = false;
var $mediadir;
var $is_odt_export = false;
function __construct() {
public function __construct()
{
global $conf;
$mediadir = $conf['mediadir'];
if (!$this->_path_is_absolute($mediadir)) {
$mediadir = DOKU_INC . '/' . $mediadir;
}
$this->mediadir = $this->_win_path_convert($this->_realpath($mediadir).'/');
$this->mediadir = $this->_win_path_convert($this->_realpath($mediadir) . '/');
}
function getType(){ return 'substition'; }
function getPType(){ return 'block'; }
function getSort(){ return 222; }
public function getType()
{
return 'substition';
}
function connectTo($mode) {
$this->Lexer->addSpecialPattern('\{\{filename>.+?\}\}',$mode,'plugin_filelist');
$this->Lexer->addSpecialPattern('\{\{filelist>.+?\}\}',$mode,'plugin_filelist');
public function getPType()
{
return 'block';
}
public function getSort()
{
return 222;
}
public function connectTo($mode)
{
$this->Lexer->addSpecialPattern('\{\{filename>.+?\}\}', $mode, 'plugin_filelist');
$this->Lexer->addSpecialPattern('\{\{filelist>.+?\}\}', $mode, 'plugin_filelist');
}
/**
* Handle the match
*/
function handle($match, $state, $pos, Doku_Handler $handler) {
public function handle($match, $state, $pos, Doku_Handler $handler)
{
// do not allow the syntax in comments
if (!$this->getConf('allow_in_comments') && isset($_REQUEST['comment']))
return false;
return false;
$match = substr($match, 2, -2);
list($type, $match) = explode('>', $match, 2);
list($pattern, $flags) = explode('&', $match, 2);
[$type, $match] = explode('>', $match, 2);
[$pattern, $flags] = explode('&', $match, 2);
if ($type == 'filename') {
if (strpos($flags, '|') !== FALSE) {
list($flags, $title) = explode('\|', $flags);
if (strpos($flags, '|') !== false) {
[$flags, $title] = explode('\|', $flags);
} else {
$title = '';
}
}
// load default config options
$flags = $this->getConf('defaults').'&'.$flags;
$flags = $this->getConf('defaults') . '&' . $flags;
$flags = explode('&', $flags);
$params = array(
'sort' => 'name',
'order' => 'asc',
'index' => 0,
'limit' => 0,
'offset' => 0,
'style' => 'list',
'tableheader' => 0,
'tableshowsize' => 0,
'tableshowdate' => 0,
'direct' => 0,
'recursive' => 0,
'titlefile' => '_title.txt',
'cache' => 0,
'randlinks' => 0,
'preview' => 0,
'previewsize' => 32,
'link' => 2,
'showsize' => 0,
'showdate' => 0,
'showcreator' => 0,
'listsep' => '", "',
'onhover' => 0,
'ftp' => 0,
);
foreach($flags as $flag) {
list($name, $value) = explode('=', $flag);
$params = ['sort' => 'name', 'order' => 'asc', 'index' => 0, 'limit' => 0, 'offset' => 0, 'style' => 'list', 'tableheader' => 0, 'tableshowsize' => 0, 'tableshowdate' => 0, 'direct' => 0, 'recursive' => 0, 'titlefile' => '_title.txt', 'cache' => 0, 'randlinks' => 0, 'preview' => 0, 'previewsize' => 32, 'link' => 2, 'showsize' => 0, 'showdate' => 0, 'showcreator' => 0, 'listsep' => '", "', 'onhover' => 0, 'ftp' => 0];
foreach ($flags as $flag) {
[$name, $value] = explode('=', $flag);
$params[trim($name)] = trim($value);
}
@@ -99,27 +93,27 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
// Trim list separator
$params['listsep'] = trim($params['listsep'], '"');
return array($type, $pattern, $params, $title, $pos);
return [$type, $pattern, $params, $title, $pos];
}
/**
* Create output
*/
function render($mode, Doku_Renderer $renderer, $data) {
public function render($mode, Doku_Renderer $renderer, $data)
{
global $conf;
list($type, $pattern, $params, $title, $pos) = $data;
[$type, $pattern, $params, $title, $pos] = $data;
if ($mode == 'odt') {
$this->is_odt_export = true;
}
// disable caching
if ($params['cache'] === 0) {
$renderer->nocache();
}
if ($mode == 'xhtml' || $mode == 'odt') {
$result = $this->_create_filelist($pattern, $params);
if ($type == 'filename') {
$result = $this->_filter_out_directories($result);
@@ -129,7 +123,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
if ($result == DOKU_PLUGIN_FILELIST_NOMATCH) {
$renderer->cdata('[n/a: ' . $this->getLang('error_nomatch') . ']');
return true;
} else if ($result == DOKU_PLUGIN_FILELIST_OUTSIDEJAIL) {
} elseif ($result == DOKU_PLUGIN_FILELIST_OUTSIDEJAIL) {
$renderer->cdata('[n/a: ' . $this->getLang('error_outsidejail') . ']');
return true;
}
@@ -140,9 +134,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
}
switch ($type) {
case 'filename':
$filename = $result['files'][$params['index']]['name'];
$filepath = $result['files'][$params['index']]['path'];
@@ -157,21 +149,21 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
case 'list':
case 'olist':
if (!$this->is_odt_export) {
$renderer->doc .= '<div class="filelist-plugin">'.DOKU_LF;
$renderer->doc .= '<div class="filelist-plugin">' . DOKU_LF;
}
$this->_render_list($result, $params, $renderer);
if (!$this->is_odt_export) {
$renderer->doc .= '</div>'.DOKU_LF;
$renderer->doc .= '</div>' . DOKU_LF;
}
break;
case 'table':
if (!$this->is_odt_export) {
$renderer->doc .= '<div class="filelist-plugin">'.DOKU_LF;
$renderer->doc .= '<div class="filelist-plugin">' . DOKU_LF;
}
$this->_render_table($result, $params, $pos, $renderer);
if (!$this->is_odt_export) {
$renderer->doc .= '</div>'.DOKU_LF;
$renderer->doc .= '</div>' . DOKU_LF;
}
break;
@@ -180,7 +172,6 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
break;
}
return true;
}
}
return false;
@@ -200,39 +191,40 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $renderer the renderer to use
* @return void
*/
function _render_link($filename, $filepath, $basedir, $webdir, $params, Doku_Renderer $renderer) {
public function _render_link($filename, $filepath, $basedir, $webdir, $params, Doku_Renderer $renderer)
{
global $conf;
//prepare for formating
$link['target'] = $conf['target']['extern'];
$link['style'] = '';
$link['pre'] = '';
$link['suf'] = '';
$link['more'] = '';
$link['url'] = $this->_get_link_url ($filepath, $basedir, $webdir, $params['randlinks'], $params['direct'], $params['ftp']);
$link['style'] = '';
$link['pre'] = '';
$link['suf'] = '';
$link['more'] = '';
$link['url'] = $this->_get_link_url($filepath, $basedir, $webdir, $params['randlinks'], $params['direct'], $params['ftp']);
$link['name'] = $filename;
$link['title'] = $renderer->_xmlEntities($link['url']);
if($conf['relnofollow']) $link['more'] .= ' rel="nofollow"';
$link['name'] = $filename;
$link['title'] = $renderer->_xmlEntities($link['url']);
if ($conf['relnofollow']) $link['more'] .= ' rel="nofollow"';
if ($params['link']) {
switch ($params['link']) {
case 1:
// Link without background image
$link['class'] = 'media';
$link['class'] = 'media';
break;
default:
// Link with background image
list($ext,$mime) = mimetype(basename($filepath));
$link['class'] .= ' mediafile mf_'.$ext;
[$ext, $mime] = mimetype(basename($filepath));
$link['class'] .= ' mediafile mf_' . $ext;
break;
}
//output formatted
if ( !$this->is_odt_export ) {
if (!$this->is_odt_export) {
$renderer->doc .= $renderer->_formatLink($link);
} else {
$this->render_odt_link ($link, $renderer);
$this->render_odt_link($link, $renderer);
}
} else {
// No link, just plain text.
@@ -247,18 +239,19 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $renderer the renderer to use
* @return void
*/
protected function render_odt_link ($link, Doku_Renderer $renderer) {
if ( method_exists ($renderer, 'getODTProperties') === true ) {
$properties = array ();
protected function render_odt_link($link, Doku_Renderer $renderer)
{
if (method_exists($renderer, 'getODTProperties')) {
$properties = [];
// Get CSS properties for ODT export.
$renderer->getODTProperties ($properties, 'a', $link['class'], NULL, 'screen');
$renderer->getODTProperties($properties, 'a', $link['class'], null, 'screen');
// Insert image if present for that media class.
if ( empty($properties ['background-image']) === false ) {
if (empty($properties ['background-image']) === false) {
$properties ['background-image'] =
$renderer->replaceURLPrefix ($properties ['background-image'], DOKU_INC);
$renderer->_odtAddImage ($properties ['background-image']);
$renderer->replaceURLPrefix($properties ['background-image'], DOKU_INC);
$renderer->_odtAddImage($properties ['background-image']);
}
}
@@ -274,7 +267,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $renderer the renderer to use
* @return void
*/
function _render_list($result, $params, Doku_Renderer $renderer) {
public function _render_list($result, $params, Doku_Renderer $renderer)
{
$this->_render_list_items($result['files'], $result['basedir'], $result['webdir'], $params, $renderer);
}
@@ -289,7 +283,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $level the level to render
* @return void
*/
function _render_list_items($files, $basedir, $webdir, $params, Doku_Renderer $renderer, $level = 1) {
public function _render_list_items($files, $basedir, $webdir, $params, Doku_Renderer $renderer, $level = 1)
{
global $conf;
if ($params['style'] == 'olist') {
@@ -306,47 +301,40 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$renderer->p_open();
}
$renderer->cdata($file['name']);
$this->_render_list_items($file['children'], $basedir, $webdir, $params, $renderer, $level+1);
$this->_render_list_items($file['children'], $basedir, $webdir, $params, $renderer, $level + 1);
if ($this->is_odt_export) {
$renderer->p_close();
}
$renderer->listitem_close();
} else if ($file['children'] === false) {
} elseif ($file['children'] === false) {
// open list item
$renderer->listitem_open($level);
if ($this->is_odt_export) {
$renderer->p_open();
}
// render the preview image
if ($params['preview']) {
$this->_render_preview_image($file['path'], $basedir, $webdir, $params, $renderer);
}
// render the file link
$this->_render_link($file['name'], $file['path'], $basedir, $webdir, $params, $renderer);
// render filesize
if ($params['showsize']) {
$renderer->cdata($params['listsep'].$this->_size_readable($file['size'], 'PiB', 'bi', '%01.1f %s'));
$renderer->cdata($params['listsep'] . $this->_size_readable($file['size'], 'PiB', 'bi', '%01.1f %s'));
}
// render lastmodified
if ($params['showdate']) {
$renderer->cdata($params['listsep'].strftime($conf['dformat'], $file['mtime']));
$renderer->cdata($params['listsep'] . strftime($conf['dformat'], $file['mtime']));
}
// render lastmodified
if ($params['showcreator']) {
$renderer->cdata($params['listsep'].$file['creator']);
$renderer->cdata($params['listsep'] . $file['creator']);
}
// close list item
if ($this->is_odt_export) {
$renderer->p_close();
}
$renderer->listitem_close();
} else {
// ignore empty directories
continue;
@@ -368,11 +356,12 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $renderer the renderer to use
* @return void
*/
function _render_table($result, $params, $pos, Doku_Renderer $renderer) {
public function _render_table($result, $params, $pos, Doku_Renderer $renderer)
{
global $conf;
if (!$this->is_odt_export) {
$renderer->table_open(NULL, NULL, $pos);
$renderer->table_open(null, null, $pos);
} else {
$columns = 1;
if ($params['tableshowsize'] || $params['showsize']) {
@@ -387,7 +376,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
if ($params['preview']) {
$columns++;
}
$renderer->table_open($columns, NULL, $pos);
$renderer->table_open($columns, null, $pos);
}
if ($params['tableheader']) {
@@ -421,7 +410,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$renderer->tableheader_open(1, 'center', 1);
switch ($params['preview']) {
case 1:
$renderer->cdata($this->getLang('preview').' / '.$this->getLang('filetype'));
$renderer->cdata($this->getLang('preview') . ' / ' . $this->getLang('filetype'));
break;
case 2:
$renderer->cdata($this->getLang('preview'));
@@ -482,10 +471,11 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $renderer the renderer to use
* @return void
*/
function _render_page($result, $params, Doku_Renderer $renderer) {
if ( method_exists ($renderer, 'getLastlevel') === false ) {
$class_vars = get_class_vars (get_class($renderer));
if ($class_vars ['lastlevel'] !== NULL) {
public function _render_page($result, $params, Doku_Renderer $renderer)
{
if (method_exists($renderer, 'getLastlevel') === false) {
$class_vars = get_class_vars(get_class($renderer));
if ($class_vars ['lastlevel'] !== null) {
// Old releases before "hrun": $lastlevel is accessible
$lastlevel = $renderer->lastlevel + 1;
} else {
@@ -510,9 +500,10 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $level the level to render
* @return void
*/
function _render_page_section($files, $basedir, $webdir, $params, Doku_Renderer $renderer, $level) {
$trees = array();
$leafs = array();
public function _render_page_section($files, $basedir, $webdir, $params, Doku_Renderer $renderer, $level)
{
$trees = [];
$leafs = [];
foreach ($files as $file) {
if ($file['children'] !== false) {
@@ -548,15 +539,16 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $renderer the renderer to use
* @return void
*/
protected function _render_preview_image ($filepath, $basedir, $webdir, $params, Doku_Renderer $renderer) {
protected function _render_preview_image($filepath, $basedir, $webdir, $params, Doku_Renderer $renderer)
{
$imagepath = $this->get_preview_image_path($filepath, $params, $isImage);
if (!empty($imagepath)) {
if ($isImage == false) {
// Generate link to returned filetype icon
$imgLink = $this->_get_link_url ($imagepath, $basedir, $webdir, 0, 1);
$imgLink = $this->_get_link_url($imagepath, $basedir, $webdir, 0, 1);
} else {
// Generate link to image file
$imgLink = $this->_get_link_url ($filepath, $basedir, $webdir, $params['randlinks'], $params['direct'], $params['ftp']);
$imgLink = $this->_get_link_url($filepath, $basedir, $webdir, $params['randlinks'], $params['direct'], $params['ftp']);
}
$previewsize = $params['previewsize'];
@@ -569,10 +561,10 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
}
if (!$this->is_odt_export) {
$renderer->doc .= '<img '.$imgclass.' style=" max-height: '.$previewsize.'px; max-width: '.$previewsize.'px;" src="'.$imgLink.'">';
$renderer->doc .= '<img ' . $imgclass . ' style=" max-height: ' . $previewsize . 'px; max-width: ' . $previewsize . 'px;" src="' . $imgLink . '">';
} else {
list($width, $height) = $renderer->_odtGetImageSize ($imagepath, $previewsize, $previewsize);
$renderer->_odtAddImage ($imagepath, $width.'cm', $height.'cm');
[$width, $height] = $renderer->_odtGetImageSize($imagepath, $previewsize, $previewsize);
$renderer->_odtAddImage($imagepath, $width . 'cm', $height . 'cm');
}
}
}
@@ -588,37 +580,32 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @return a filelist data structure containing the found files and base-
* and webdir
*/
function _create_filelist($pattern, $params) {
public function _create_filelist($pattern, $params)
{
global $conf;
global $ID;
$allowed_absolute_paths = explode(',', $this->getConf('allowed_absolute_paths'));
$result = array(
'files' => array(),
'basedir' => false,
'webdir' => false,
);
$result = ['files' => [], 'basedir' => false, 'webdir' => false];
// we don't want to use $conf['media'] here as that path has symlinks resolved
if (!$params['direct']) {
// if media path is not absolute, precede it with the current namespace
if ($pattern[0] != ':') {
$pattern = ':'.getNS($ID) . ':' . $pattern;
$pattern = ':' . getNS($ID) . ':' . $pattern;
}
// replace : with / and prepend mediadir
$pattern = $this->mediadir . str_replace(':', '/', $pattern);
} elseif($params['direct'] == 2){
} elseif ($params['direct'] == 2) {
// treat path as relative to first configured path
$pattern = $allowed_absolute_paths[0].'/'.$pattern;
} else {
$pattern = $allowed_absolute_paths[0] . '/' . $pattern;
} elseif (!$this->_path_is_absolute($pattern)) {
// if path is not absolute, precede it with DOKU_INC
if (!$this->_path_is_absolute($pattern)) {
$pattern = DOKU_INC.$pattern;
}
$pattern = DOKU_INC . $pattern;
}
// get the canonicalized basedir (without resolving symlinks)
$dir = $this->_realpath($this->_win_path_convert(dirname($pattern))).'/';
$dir = $this->_realpath($this->_win_path_convert(dirname($pattern))) . '/';
// if the directory does not exist, we of course have no matches
if (!$dir || !file_exists($dir)) {
@@ -629,10 +616,11 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$web_paths = explode(',', $this->getConf('web_paths'));
$basedir = false;
$webdir = false;
if (count($allowed_absolute_paths) == count($web_paths)) {
for($i = 0; $i < count($allowed_absolute_paths); $i++) {
if (count($allowed_absolute_paths) === count($web_paths)) {
$counter = count($allowed_absolute_paths);
for ($i = 0; $i < $counter; $i++) {
$abs_path = $this->_win_path_convert(trim($allowed_absolute_paths[$i]));
if (strstr($dir, $abs_path) == $dir) {
if (strstr($dir, (string) $abs_path) == $dir) {
$basedir = $abs_path;
$webdir = trim($web_paths[$i]);
break;
@@ -662,19 +650,19 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$callback = false;
$reverseflag = false;
if ($params['sort'] == 'mtime') {
$callback = array($this, '_compare_mtimes');
$callback = [$this, '_compare_mtimes'];
if ($params['order'] == 'asc') $reverseflag = true;
} else if ($params['sort'] == 'ctime') {
$callback = array($this, '_compare_ctimes');
} elseif ($params['sort'] == 'ctime') {
$callback = [$this, '_compare_ctimes'];
if ($params['order'] == 'asc') $reverseflag = true;
} else if ($params['sort'] == 'size') {
$callback = array($this, '_compare_sizes');
} elseif ($params['sort'] == 'size') {
$callback = [$this, '_compare_sizes'];
if ($params['order'] == 'desc') $reverseflag = true;
} else if ($params['sort'] == 'iname') {
$callback = array($this, '_compare_inames');
} elseif ($params['sort'] == 'iname') {
$callback = [$this, '_compare_inames'];
if ($params['order'] == 'desc') $reverseflag = true;
} else {
$callback = array($this, '_compare_names');
$callback = [$this, '_compare_names'];
if ($params['order'] == 'desc') $reverseflag = true;
}
$this->_sort_filelist($result['files'], $callback, $reverseflag);
@@ -682,8 +670,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
// return the list
if (count($result['files']) > 0)
return $result;
else
return DOKU_PLUGIN_FILELIST_NOMATCH;
else return DOKU_PLUGIN_FILELIST_NOMATCH;
}
/**
@@ -695,9 +682,12 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $reverse true if the result is to be reversed
* @return the sorted tree
*/
function _sort_filelist(&$files, $callback, $reverse) {
public function _sort_filelist(&$files, $callback, $reverse)
{
// sort subtrees
for ($i = 0; $i < count($files); $i++) {
$counter = count($files);
// sort subtrees
for ($i = 0; $i < $counter; $i++) {
if ($files[$i]['children'] !== false) {
$children = $files[$i]['children'];
$this->_sort_filelist($children, $callback, $reverse);
@@ -720,8 +710,9 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $prefix the prefix to attach to all processed nodes
* @return a flattened representation of the tree
*/
function _flatten_filelist($files, $prefix = '') {
$result = array();
public function _flatten_filelist($files, $prefix = '')
{
$result = [];
foreach ($files as $file) {
if ($file['children'] !== false) {
$result = array_merge($result, $this->_flatten_filelist($file['children'], $prefix . $file['name'] . '/'));
@@ -741,12 +732,13 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* DOKU_PLUGIN_FILELIST_NOMATCH if there are no files left or
* the given result if it was not an array (but an errorcode)
*/
function _filter_out_directories($result) {
public function _filter_out_directories($result)
{
if (!is_array($result)) {
return $result;
}
$filtered = array();
$filtered = [];
$files = $result['files'];
foreach ($files as $file) {
if ($file['children'] === false) {
@@ -772,7 +764,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
*
* @see <http://www.php.net/manual/en/function.glob.php#71083>
*/
function _crawl_files($pattern, $params) {
public function _crawl_files($pattern, $params)
{
$split = explode('/', $pattern);
$match = array_pop($split);
$path = implode('/', $split);
@@ -780,13 +773,13 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
return false;
}
$ext = explode(',',$this->getConf('extensions'));
$ext = array_map('trim',$ext);
$ext = array_map('preg_quote_cb',$ext);
$ext = join('|',$ext);
$ext = explode(',', $this->getConf('extensions'));
$ext = array_map('trim', $ext);
$ext = array_map('preg_quote_cb', $ext);
$ext = implode('|', $ext);
if (($dir = opendir($path)) !== false) {
$result = array();
$result = [];
while (($file = readdir($dir)) !== false) {
if ($file == '.' || $file == '..') {
// ignore . and ..
@@ -803,7 +796,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$filepath = $path . '/' . $file;
if ($this->_fnmatch($match, $file) || (is_dir($filepath) && $params['recursive'])) {
if(!is_dir($filepath) && !preg_match('/('.$ext.')$/i',$file)){
if (!is_dir($filepath) && !preg_match('/(' . $ext . ')$/i', $file)) {
continue;
}
@@ -812,8 +805,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$mid = $this->_convert_mediapath($filepath);
$perm = auth_quickaclcheck($mid);
if ($perm < AUTH_READ) continue;
} else {
if (!is_readable($filepath)) continue;
} elseif (!is_readable($filepath)) {
continue;
}
$filename = $file;
@@ -825,10 +818,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
if (is_readable($titlefile) && $perm >= AUTH_READ) {
$filename = io_readFile($titlefile, false);
}
} else {
if (is_readable($titlefile)) {
$filename = io_readFile($titlefile, false);
}
} elseif (is_readable($titlefile)) {
$filename = io_readFile($titlefile, false);
}
}
@@ -839,7 +830,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$medialog = new MediaChangeLog($mid);
$revinfo = $medialog->getRevisionInfo(@filemtime(fullpath(mediaFN($mid))));
if($revinfo['user']) {
if ($revinfo['user']) {
$creator = $revinfo['user'];
} else {
$creator = $revinfo['ip'];
@@ -849,16 +840,7 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
$creator = $this->getLang('creatorunknown');
}
$entry = array(
'name' => $filename,
'path' => $filepath,
'mtime' => filemtime($filepath),
'ctime' => filectime($filepath),
'size' => filesize($filepath),
'children' => ((is_dir($filepath) && $params['recursive']) ? $this->_crawl_files($filepath . '/' . $match, $params) : false),
'treesize' => 0,
'creator' => $creator,
);
$entry = ['name' => $filename, 'path' => $filepath, 'mtime' => filemtime($filepath), 'ctime' => filectime($filepath), 'size' => filesize($filepath), 'children' => ((is_dir($filepath) && $params['recursive']) ? $this->_crawl_files($filepath . '/' . $match, $params) : false), 'treesize' => 0, 'creator' => $creator];
// calculate tree size
if ($entry['children'] !== false) {
@@ -883,33 +865,29 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
//~~ Comparators
function _compare_names($a, $b) {
public function _compare_names($a, $b)
{
return strcmp($a['name'], $b['name']);
}
function _compare_inames($a, $b) {
public function _compare_inames($a, $b)
{
return strcmp(strtolower($a['name']), strtolower($b['name']));
}
function _compare_ctimes($a, $b) {
if ($a['ctime'] == $b['ctime']) {
return 0;
}
return (($a['ctime'] < $b['ctime']) ? -1 : 1);
public function _compare_ctimes($a, $b)
{
return $a['ctime'] <=> $b['ctime'];
}
function _compare_mtimes($a, $b) {
if ($a['mtime'] == $b['mtime']) {
return 0;
}
return (($a['mtime'] < $b['mtime']) ? -1 : 1);
public function _compare_mtimes($a, $b)
{
return $a['mtime'] <=> $b['mtime'];
}
function _compare_sizes($a, $b) {
if ($a['size'] == $b['size']) {
return 0;
}
return (($a['size'] < $b['size']) ? -1 : 1);
public function _compare_sizes($a, $b)
{
return $a['size'] <=> $b['size'];
}
//~~ Utility functions
@@ -920,16 +898,18 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @author anonymous
* @see <http://www.php.net/manual/en/function.realpath.php#73563>
*/
function _realpath($path) {
$path=explode('/', $path);
$output=array();
for ($i=0; $i<sizeof($path); $i++) {
public function _realpath($path)
{
$path = explode('/', $path);
$output = [];
$counter = count($path);
for ($i = 0; $i < $counter; $i++) {
if ('.' == $path[$i]) continue;
if ('..' == $path[$i] && '..' != $output[sizeof($output) - 1]) {
if ('..' == $path[$i] && '..' != $output[count($output) - 1]) {
array_pop($output);
continue;
}
array_push($output, $path[$i]);
$output[] = $path[$i];
}
return implode('/', $output);
}
@@ -940,8 +920,9 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @author jk at ricochetsolutions dot com
* @see <http://www.php.net/manual/en/function.fnmatch.php#71725>
*/
function _fnmatch($pattern, $string) {
return preg_match("#^".strtr(preg_quote($pattern, '#'), array('\*' => '.*', '\?' => '.', '\[' => '[', '\]' => ']'))."$#i", $string);
public function _fnmatch($pattern, $string)
{
return preg_match("#^" . strtr(preg_quote($pattern, '#'), ['\*' => '.*', '\?' => '.', '\[' => '[', '\]' => ']']) . "$#i", $string);
}
/**
@@ -950,29 +931,30 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $path the path to convert
* @return the converted path
*/
function _win_path_convert($path) {
public function _win_path_convert($path)
{
return str_replace('\\', '/', trim($path));
}
/**
* Return human readable sizes
*
* @author Aidan Lister <aidan@php.net>
* @param int $size size in bytes
* @param string $max maximum unit
* @param string $system 'si' for SI, 'bi' for binary prefixes
* @param string $retstring return string format
* @version 1.3.0
* @link http://aidanlister.com/repos/v/function.size_readable.php
* @param int $size size in bytes
* @param string $max maximum unit
* @param string $system 'si' for SI, 'bi' for binary prefixes
* @param string $retstring return string format
* @author Aidan Lister <aidan@php.net>
*/
function _size_readable($size, $max = null, $system = 'si', $retstring = '%01.2f %s')
public function _size_readable($size, $max = null, $system = 'si', $retstring = '%01.2f %s')
{
// Pick units
$systems['si']['prefix'] = array('B', 'K', 'MB', 'GB', 'TB', 'PB');
$systems['si']['size'] = 1000;
$systems['bi']['prefix'] = array('B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB');
$systems['bi']['size'] = 1024;
$sys = isset($systems[$system]) ? $systems[$system] : $systems['si'];
$systems['si']['prefix'] = ['B', 'K', 'MB', 'GB', 'TB', 'PB'];
$systems['si']['size'] = 1000;
$systems['bi']['prefix'] = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB'];
$systems['bi']['size'] = 1024;
$sys = $systems[$system] ?? $systems['si'];
// Max unit to display
$depth = count($sys['prefix']) - 1;
@@ -999,7 +981,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $path the path to check
* @return true if path is absolute, false otherwise
*/
function _path_is_absolute($path) {
public function _path_is_absolute($path)
{
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
if ($path[1] == ':' || ($path[0] == '/' && $path[1] == '/')) {
return true;
@@ -1010,7 +993,8 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
}
}
function _convert_mediapath($path) {
public function _convert_mediapath($path)
{
$mid = str_replace('/', ':', substr($path, strlen($this->mediadir))); // strip media base dir
return ltrim($mid, ':'); // strip leading :
}
@@ -1027,23 +1011,28 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $filename the file to check
* @return string Image to use for preview image
*/
protected function get_preview_image_path ($filename, $params, &$isImage) {
list($ext,$mime) = mimetype(basename($filename));
protected function get_preview_image_path($filename, $params, &$isImage)
{
[$ext, $mime] = mimetype(basename($filename));
$imagepath = '';
$isImage = false;
if (($params['preview'] == 1 || $params['preview'] == 2) &&
strncmp($mime, 'image', strlen('image')) == 0) {
if (
($params['preview'] == 1 || $params['preview'] == 2) &&
strncmp($mime, 'image', strlen('image')) == 0
) {
// The file is an image. Return itself as the image path.
$imagepath = $filename;
$isImage = true;
}
if (($params['preview'] == 1 && empty($imagepath)) ||
$params['preview'] == 3 ) {
if (
($params['preview'] == 1 && empty($imagepath)) ||
$params['preview'] == 3
) {
// No image. Return DokuWiki image for file extension.
if (!empty($ext)) {
$imagepath = DOKU_INC.'lib/images/fileicons/32x32/'.$ext.'.png';
$imagepath = DOKU_INC . 'lib/images/fileicons/32x32/' . $ext . '.png';
} else {
$imagepath = DOKU_INC.'lib/images/fileicons/32x32/file.png';
$imagepath = DOKU_INC . 'lib/images/fileicons/32x32/file.png';
}
}
return $imagepath;
@@ -1058,22 +1047,22 @@ class syntax_plugin_filelist extends DokuWiki_Syntax_Plugin {
* @param $params the parameters of the filelist call
* @return string the generated URL
*/
protected function _get_link_url ($filepath, $basedir, $webdir, $randlinks, $direct, $ftp=false) {
protected function _get_link_url($filepath, $basedir, $webdir, $randlinks, $direct, $ftp = false)
{
$urlparams = '';
if ($randlinks) {
$urlparams = '?'.time();
$urlparams = '?' . time();
}
if (!$direct) {
$url = ml(':'.$this->_convert_mediapath($filepath)).$urlparams;
$url = ml(':' . $this->_convert_mediapath($filepath)) . $urlparams;
} else {
$url = $webdir.substr($filepath, strlen($basedir)).$urlparams;
if ($ftp)
{
$url = str_replace('\\','/', $url);
$url = $webdir . substr($filepath, strlen($basedir)) . $urlparams;
if ($ftp) {
$url = str_replace('\\', '/', $url);
if (strpos($url, 'http') === false) {
$url = 'ftp:'.$url;
$url = 'ftp:' . $url;
} else {
$url = str_replace('http','ftp', $url);
$url = str_replace('http', 'ftp', $url);
}
}
}