| version 1.6, 2002/08/04 23:26:22 |
version 1.7, 2003/02/12 19:15:49 |
|
|
| |
phpWebFileManager |
| |
----------------- |
| |
|
| phpWebFileManagerfile management PHP script designed for including into |
phpWebFileManager is web file management PHP tool. |
| large projectsOndrej 'Nepto' Jombik |
|
| |
|
| Copyright © 2001, 2002 by Platon software development group |
phpWebFileManager is file management tool, written in PHP. It is |
| _______________________________________________________________________ |
designed for inclusion in large projects, and it can also act as a |
| |
PostNuke module. Its main features are multi-language support, secure |
| |
directory browsing, directory creation and removal, file creation, |
| |
uploading, renaming, deleting, and viewing. There is also a powerful |
| |
configuration file that allows you to allow/deny appropriate file |
| |
management actions. |
| |
|
| |
For full information, such as installation notes, configuration issues, |
| |
examples of usage and others, refer to HTML or PDF documentation, |
| |
available as separate package from phpWebFileManager homepage. |
| |
|
| Table of Contents |
Developed by Ondrej Jombik <nepto@platon.sk> |
| 1. Introduction |
Copyright (c) 2001-2003 Platon SDG, http://www.platon.sk/ |
| |
|
| 1.1. Overview |
The official phpWebFileManager homepage is: |
| 1.2. Features |
|
| 1.3. Requirements |
|
| 1.4. Supported clients |
|
| |
|
| 2. Usage |
|
| |
|
| 2.1. Installation |
|
| 2.2. Configuration |
|
| |
|
| 2.2.1. Original variables property |
|
| 2.2.2. Other properties |
|
| 2.2.3. File upload |
|
| 2.2.4. PostNuke compatibility |
|
| 2.2.5. Plugins |
|
| |
|
| 2.3. Running |
|
| 2.4. Security notes |
|
| |
|
| 3. Other information |
|
| |
|
| 3.1. License |
|
| 3.2. Request to users |
|
| 3.3. Author and homepage |
|
| 3.4. Version history |
|
| _________________________________________________________________ |
|
| |
|
| Chapter 1. Introduction |
|
| |
|
| 1.1. Overview |
|
| |
|
| phpWebFileManager is file management PHP tool. It is designed for including |
|
| in large projects using appropriate PHP mechanisms (in example include() or |
|
| similar function). |
|
| _________________________________________________________________ |
|
| |
|
| 1.2. Features |
|
| |
|
| * secure directory browsing |
|
| * directory creating, renaming and removing |
|
| * file creating, uploading, renaming, deleting and viewing |
|
| * file edition and saving |
|
| * huge configuration ability to allow/deny appropriate actions |
|
| * PostNuke Rogue add-on compatibility |
|
| * multilanguage support |
|
| _________________________________________________________________ |
|
| |
|
| 1.3. Requirements |
|
| |
|
| phpWebFileManager requires PHP interpreter without any special modules. It |
|
| is developed with with PHP 4.10.0. Although I haven't tested it, it should |
|
| work also with another versions of PHP, even PHP 3.x.x. Please notice me |
|
| about particular compatibility capabilities. |
|
| _________________________________________________________________ |
|
| |
|
| 1.4. Supported clients |
|
| |
|
| Netscape Navigator, Opera, Mozilla, Konqueror, Microsoft Internet Explorer, |
|
| Lynx, Links and all others HTML compliant clients are supported. Nor |
|
| Javascript nor other forms of client side scripting are used. |
|
| _________________________________________________________________ |
|
| |
|
| Chapter 2. Usage |
|
| |
|
| 2.1. Installation |
|
| |
|
| Unpack archive to some directory, which could be accessed from Web. |
|
| |
|
| Change mode of created phpWebFileManager directory so it can be accessed |
|
| from Web. Command |
|
| |
|
| chmod -R u=rwX,g-rwx,o=rX phpWebFileManager/ |
|
| |
|
| will do the job. Installation is done. |
|
| _________________________________________________________________ |
|
| |
|
| 2.2. Configuration |
|
| |
|
| Configuration variables are located in config.inc.php file. |
|
| _________________________________________________________________ |
|
| |
|
| 2.2.1. Original variables property |
|
| |
|
| Determine if you want to use phpWebFileManager as a standalone Web |
|
| application or you want to include it in some bigger project. |
|
| |
|
| * If you want to use it as an standalone application, edit the |
|
| config file and ignore $phpWebFileManager_ORIGINAL_VARIABLES |
|
| variable. |
|
| * If you want to use as a part of some bigger project, edit the |
|
| config file with focusing on |
|
| $phpWebFileManager_ORIGINAL_VARIABLES. phpWebFileManager provides |
|
| itself a lot of actions such as confirm of deletion file and |
|
| others. $phpWebFileManager_ORIGINAL_VARIABLES are variables, which |
|
| will phpWebFileManager keep, so each page reload will be processed |
|
| in right way by others components of your PHP script. |
|
| If $phpWebFileManager_ORIGINAL_VARIABLES is not a constant, you |
|
| can comment it out in config file and always set it in your main |
|
| program to the right value before doing command which will include |
|
| phpWebFileManager.php file. |
|
| _________________________________________________________________ |
|
| |
|
| 2.2.2. Other properties |
|
| |
|
| Than edit others variables in config file. More information about every |
|
| specific variable are described in config.inc.php file. |
|
| _________________________________________________________________ |
|
| |
|
| 2.2.3. File upload |
|
| |
|
| If you want to provide file uploading, you must create world writeable |
|
| directory. Imagine that it is directory upload/, so than run command |
|
| |
|
| chmod o+w upload/ |
|
| |
|
| to make it world writeable. |
|
| _________________________________________________________________ |
|
| |
|
| 2.2.4. PostNuke compatibility |
|
| |
|
| Since version 0.2.2 phpWebFileManager has an ability to act as a PostNuke |
|
| Rogue module (add-on). |
|
| |
|
| Simply copy the directory into modules/ subdirectory of your PostNuke |
|
| installation. Than log into administration and in subsection Modules |
|
| regenerate module list. You can than initialize and activate |
|
| phpWebFileManager module and if you like, make it accessible through some |
|
| block and so on. |
|
| |
|
| You might want also use some of security features of PostNuke. If you choose |
|
| to have phpWebFileManager menu entry visible only for trusted user with |
|
| admin rights, go to the administration subsection Permissions and make |
|
| appropriate changes. |
|
| |
|
| PostNuke specific configuration is overriden in init.inc.php file. Note, |
|
| that currently none from allow/deny file management actions features are |
|
| used. This will probably change soon, when someone from the PostNuke |
|
| community help me with setting up particular rights according to internal |
|
| PostNuke user information. |
|
| _________________________________________________________________ |
|
| |
|
| 2.2.5. Plugins |
|
| |
|
| Since version 0.3 of phpWebFileManager you can use also plugins attached to |
|
| distribution. |
|
| |
|
| The first one, auth.php, allows you to restrict access to phpWebFileManager |
|
| script using HTTP authentication. Refer to that file for more information. |
|
| You have to edit username and password in that file and set up (just |
|
| uncomment) appropriate require_once call in config.inc.php configuration |
|
| file. |
|
| |
|
| The second one plugin called file.php. It allows you to restrict access to |
|
| View files. More information about usage of this plugin are in that file, |
|
| where you may also need to edit location of apache-mime.types file. |
|
| _________________________________________________________________ |
|
| |
|
| 2.3. Running |
|
| |
|
| If you have edited config file and wanted phpWebFileManager as a standalone |
|
| application, try to access phpWebFileManager using some web browser. |
|
| |
|
| If you want to run it as a part of some other web application, write |
|
| include() or require() command with path and filename to file |
|
| phpWebFileManager.php on the place, where you want to have file manager. |
|
| _________________________________________________________________ |
|
| |
|
| 2.4. Security notes |
|
| |
|
| If you want to secure phpWebFileManager, put security stuff commands or |
|
| include() command to security stuff script at the beginning of config file. |
|
| That file is loaded by init.inc.php at the beggining of script execution. |
|
| _________________________________________________________________ |
|
| |
|
| Chapter 3. Other information |
|
| |
|
| 3.1. License |
|
| |
|
| Developed by Ondrej Jombík <nepto@pobox.sk>, http://nepto.sk/. |
|
| |
|
| Copyright (c) 2001-2002 Platon software development group, |
|
| http://www.platon.sk/ |
|
| |
|
| 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, 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., 59 Temple |
|
| Place - Suite 330, Boston, MA 02111-1307, USA. |
|
| _________________________________________________________________ |
|
| |
|
| 3.2. Request to users |
|
| |
|
| I have an incomplete mastery of the English language, so please help correct |
|
| the text of the documents and messages in this program. Comments, |
|
| suggestions, bug reports and patches are always welcome. Please e-mail them |
|
| to the following <platon@pobox.sk> e-mail address and write |
|
| 'phpWebFileManager' keyword in the Subject line. |
|
| |
|
| Likewise, if you don't find in language/ subdirectory a translation into |
|
| your language, you can make one. But firstly ask me, if that translation is |
|
| not already made, because you could not have actual version of |
|
| phpWebFileManager. |
|
| _________________________________________________________________ |
|
| |
|
| 3.3. Author and homepage |
|
| |
|
| Author is Ondrej Jombik <nepto@pobox.sk>, http://nepto.sk/. |
|
| |
|
| Feel free to e-mail me any bug reports, suggestions and question about this |
|
| PHP script. |
|
| |
|
| The latest official release of phpWebFileManager is available from: |
|
| http://www.platon.sk/projects/phpWebFileManager/ |
http://www.platon.sk/projects/phpWebFileManager/ |
| _________________________________________________________________ |
|
| |
|
| 3.4. Version history |
|
| |
|
| Current version is 0.4 and it was released in 4th August 2002. |
|
| |
|
| version 0.4, August 4, 2002 (official release) |
|
| |
|
| * improved file.php pluging |
|
| * new configuration item for external file resources added |
|
| * definedable CGI variables prefix implemented |
|
| * definedable icons directory to have possibility of default Apache |
|
| icons (/icons/) usage |
|
| * more file type icons are handled using specific icons |
|
| configuration file icons.inc.php |
|
| * improved HTML output; fixed some bug with colspan and & |
|
| |
|
| version 0.3.1, August 3, 2002 |
|
| |
|
| * plugins moved into plugins/ subdirectory |
|
| * register globals off compliancy |
|
| * support for file edit and save; based on the patch by Robert |
|
| Paciorek <Robert.Paciorek@n17.waw.pl> |
|
| |
|
| version 0.3, July 22, 2002 (official release) |
|
| |
|
| * configuration options and configuration file change (from |
|
| $phpWebFileManager_OPTION to $fm_cfg['option']) |
|
| * note, that features forbid contants were removed and substitued by |
|
| features enabled constants; keep this in mind when upgrade on this |
|
| version |
|
| * plugin file.php by Tony J. White <tjw@tjw.org> used for file |
|
| viewing with ability to deny this feature according to used |
|
| configuration was added into phpWebFileManager distribution |
|
| * plugin auth.php containing basic HTTP authentication was also |
|
| added into distribution |
|
| |
|
| version 0.2.3, July 19, 2002 |
|
| |
|
| Changes by Asbjørn Værnes <avaernes@online.no>: |
|
| |
|
| * dirty fix for proper handling filenames with norwegian characters |
|
| * norwegian translation |
|
| |
|
| version 0.2.2, April 21, 2002 |
|
| |
|
| * fixed PostNuke port, init.inc.php file created for initialization |
|
| * new subdirectory lib/ created for phpPlatonLib functions, |
|
| url_utils.lib.php file removed |
|
| * various documentation update, Ken Kizaki's PN-MODULE-HOWTO added |
|
| to distribution |
|
| |
|
| Changes by Rastislav 'Rider' Rihak <rider@lonestar.sk>: |
|
| |
|
| * PostNuke Rogue port |
|
| * new multilanguage support system |
|
| * startup redirection file index.php removed |
|
| |
|
| version 0.2.1, March 25, 2002 |
|
| |
|
| * ability to overide date format in config file |
|
| * support for enable/disable icons displaying |
|
| * all variables were uncommented in config file to prevent its |
|
| initialization from CGI environment |
|
| |
|
| Changes by Ken Kizaki <ken_kizaki@yahoo.co.jp> and Daniel Fernandez |
|
| <funkyferdy@econophone.ch>: |
|
| |
|
| * german translation |
|
| |
|
| Changes by Greg Baker <ggbaker@cs.sfu.ca>: |
|
| |
|
| * file size and last modification date support |
|
| * date format in language translation files |
|
| |
|
| version 0.2, February 21, 2002 (official release) |
|
| |
|
| * several features have been implemented, phpWebFileManager seems to |
|
| be stable now, although according to TODO list, new things will be |
|
| added soon |
|
| |
|
| version 0.1.8, February 16, 2002 |
|
| |
|
| * multilanguage support |
|
| * english and slovak translation added |
|
| * ability to deny symbolic links following |
|
| * add striping slashes from CGI variables to properly handle |
|
| directories with quotation characters |
|
| * quoted value parameters of all input tag |
|
| * HTML validity improvements |
|
| * documentation changes |
|
| |
|
| version 0.1.7, December 18, 2001 |
|
| |
|
| * added parameters into config file to specify background color of |
|
| even and odd rows |
|
| * fm_ prefix for CGI variables to avoid variable name collisions in |
|
| large projects |
|
| |
|
| version 0.1.6, October 24, 2001 |
|
| |
|
| * finally valid handling of all file and directory names (with |
|
| spaces, ampersands, quotes, etc) and also valid HTML references |
|
| (links) creating using appropriate functions urlencode() and |
|
| htmlentities() |
|
| |
|
| version 0.1.5, October 1, 2001 |
|
| |
|
| * added $phpWebFileManager_LINKS_PREFIX parameter to build links for |
|
| View feature; if it is not present HTML links are built in |
|
| standart way |
|
| |
|
| version 0.1.4, September 26, 2001 |
|
| |
|
| * added ability to allow user to turn on/off View/Enter, Rename |
|
| Delete/Remove and Create/Upload functionality with focus on |
|
| security |
|
| |
|
| version 0.1.3, August 23, 2001 |
|
| |
|
| Changes by Paul Grace <paulgrace@telstra.com>: |
|
| |
|
| * directories with spaces handling |
|
| * alphabetical directory sorting |
|
| |
|
| version 0.1.2, July 31, 2001 |
|
| |
|
| * documentation and TODO list update |
|
| |
|
| version 0.1.1, July 27, 2001 |
The phpWebFileManager project management page is: |
| |
http://www.platon.sk/projects/main_page.php?project_id=4 |
| |
|
| * change relative redirect to absolute in index.php (RFC2068) |
Use phpWebFileManager project management page to submit bugs, feature |
| * fixing file view |
requests, suggestions for improvements or improved code. There is also |
| |
online documentation browser, download central and discussion forum |
| |
available for asking support questions. |
| |
|
| version 0.1, July 22, 2001 (official release) |
This document was written by Ondrej Jombik in 12th February 2003. |
| |
|
| * initial release |
|