From 1c9be8254bd13c85be728699ceb68c34d7fd5d89 Mon Sep 17 00:00:00 2001 From: Andreas Gohr Date: Mon, 26 Feb 2024 11:58:11 +0100 Subject: [PATCH] initial automatic cleanup --- .gitattributes | 2 + .github/workflows/dokuwiki.yml | 11 + .travis.yml | 13 - LICENSE | 339 +++++++++++++++++++++++++ _test/GeneralTest.php | 86 +++++++ conf/default.php | 1 + conf/metadata.php | 2 +- syntax.php | 437 ++++++++++++++++----------------- 8 files changed, 653 insertions(+), 238 deletions(-) create mode 100644 .gitattributes create mode 100644 .github/workflows/dokuwiki.yml delete mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 _test/GeneralTest.php diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..050b5e0 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +/.* export-ignore +/_test export-ignore diff --git a/.github/workflows/dokuwiki.yml b/.github/workflows/dokuwiki.yml new file mode 100644 index 0000000..8268881 --- /dev/null +++ b/.github/workflows/dokuwiki.yml @@ -0,0 +1,11 @@ +name: DokuWiki Default Tasks +on: + push: + pull_request: + schedule: + - cron: '58 2 25 * *' + + +jobs: + all: + uses: dokuwiki/github-action/.github/workflows/all.yml@main diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 0e27461..0000000 --- a/.travis.yml +++ /dev/null @@ -1,13 +0,0 @@ -language: php -php: - - "7.0" - - "5.6" -# - "5.5" -# - "5.4" -# - "5.3" -env: - - DOKUWIKI=master - - DOKUWIKI=stable -before_install: wget https://raw.github.com/splitbrain/dokuwiki-travis/master/travis.sh -install: sh travis.sh -script: cd _test && phpunit --stderr --group plugin_filelist diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/_test/GeneralTest.php b/_test/GeneralTest.php new file mode 100644 index 0000000..e22e2dc --- /dev/null +++ b/_test/GeneralTest.php @@ -0,0 +1,86 @@ +assertFileExists($file); + + $info = confToHash($file); + + $this->assertArrayHasKey('base', $info); + $this->assertArrayHasKey('author', $info); + $this->assertArrayHasKey('email', $info); + $this->assertArrayHasKey('date', $info); + $this->assertArrayHasKey('name', $info); + $this->assertArrayHasKey('desc', $info); + $this->assertArrayHasKey('url', $info); + + $this->assertEquals('filelist', $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']); + $this->assertTrue(false !== strtotime($info['date'])); + } + + /** + * Test to ensure that every conf['...'] entry in conf/default.php has a corresponding meta['...'] entry in + * conf/metadata.php. + */ + public function testPluginConf(): void + { + $conf_file = __DIR__ . '/../conf/default.php'; + $meta_file = __DIR__ . '/../conf/metadata.php'; + + if (!file_exists($conf_file) && !file_exists($meta_file)) { + self::markTestSkipped('No config files exist -> skipping test'); + } + + if (file_exists($conf_file)) { + include($conf_file); + } + if (file_exists($meta_file)) { + include($meta_file); + } + + $this->assertEquals( + gettype($conf), + gettype($meta), + 'Both ' . DOKU_PLUGIN . 'filelist/conf/default.php and ' . DOKU_PLUGIN . 'filelist/conf/metadata.php have to exist and contain the same keys.' + ); + + if ($conf !== null && $meta !== null) { + foreach ($conf as $key => $value) { + $this->assertArrayHasKey( + $key, + $meta, + 'Key $meta[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'filelist/conf/metadata.php' + ); + } + + foreach ($meta as $key => $value) { + $this->assertArrayHasKey( + $key, + $conf, + 'Key $conf[\'' . $key . '\'] missing in ' . DOKU_PLUGIN . 'filelist/conf/default.php' + ); + } + } + + } +} diff --git a/conf/default.php b/conf/default.php index 09fdf9e..c5a2daa 100644 --- a/conf/default.php +++ b/conf/default.php @@ -1,4 +1,5 @@ _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 .= '
'.DOKU_LF; + $renderer->doc .= '
' . DOKU_LF; } $this->_render_list($result, $params, $renderer); if (!$this->is_odt_export) { - $renderer->doc .= '
'.DOKU_LF; + $renderer->doc .= '
' . DOKU_LF; } break; case 'table': if (!$this->is_odt_export) { - $renderer->doc .= '
'.DOKU_LF; + $renderer->doc .= '
' . DOKU_LF; } $this->_render_table($result, $params, $pos, $renderer); if (!$this->is_odt_export) { - $renderer->doc .= '
'.DOKU_LF; + $renderer->doc .= '
' . 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 .= ''; + $renderer->doc .= ''; } 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 */ - 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 */ - function _realpath($path) { - $path=explode('/', $path); - $output=array(); - for ($i=0; $i */ - 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 + * @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 */ - 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); } } }