| version 1.8, 2002/04/21 15:59:36 |
version 1.9, 2002/05/06 18:28:52 |
|
|
| <!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[ |
| <!-- $Id$ --> |
<!-- $Id$ --> |
| |
<!ENTITY introduction SYSTEM "introduction.sgml"> |
| |
<!ENTITY usage SYSTEM "usage.sgml"> |
| |
<!ENTITY other-information SYSTEM "other-information.sgml"> |
| |
]> |
| <!-- |
<!-- |
| |
|
| Blbosti v DocBooku: |
Blbosti v DocBooku: |
| Line 16 Blbosti v DocBooku: |
|
| Line 20 Blbosti v DocBooku: |
|
| |
|
| --> |
--> |
| |
|
| <book id="phpwebfilemanager-manual"> |
<book id="index"> |
| <bookinfo> |
<bookinfo> |
| <date>2002-04-08</date> |
<date>2002-04-08</date> |
| <title>phpWebFileManager</title> |
<title>phpWebFileManager</title> |
| <abbrev>phpWebFileManager</abbrev> |
<abbrev>phpWebFileManager</abbrev> |
| <subtitle> |
<subtitle> |
| file management PHP script designed |
file management PHP script designed for including into large projects |
| for including into large projects |
|
| </subtitle> |
</subtitle> |
| <releaseinfo>This document is the user's manual for phpWebFileManager.</releaseinfo> |
<releaseinfo> |
| |
This document is the user's manual for phpWebFileManager. |
| |
</releaseinfo> |
| <authorgroup> |
<authorgroup> |
| <author> |
<author> |
| <firstname>Ondrej</firstname> |
<firstname>Ondrej</firstname> |
| Line 36 Blbosti v DocBooku: |
|
| Line 41 Blbosti v DocBooku: |
|
| <copyright> |
<copyright> |
| <year>2001</year> |
<year>2001</year> |
| <year>2002</year> |
<year>2002</year> |
| <holder>Ondrej 'Nepto' Jombik</holder> |
<holder>Platon software development group</holder> |
| </copyright> |
</copyright> |
| </bookinfo> |
</bookinfo> |
| |
|
| |
&introduction; |
| <chapter id="introduction"> |
&usage; |
| <title>Introduction</title> |
&other-information; |
| <sect1 id="overview"> |
|
| <title>Overview</title> |
|
| <para> |
|
| |
|
| phpWebFileManager is file management PHP tool. It is designed for including in |
|
| large projects using appropriate PHP mechanisms (in example |
|
| <function>include()</function> or similar function). |
|
| |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="features"> |
|
| <title>Features</title> |
|
| <para> |
|
| <itemizedlist mark=opencircle> |
|
| <listitem><para>secure directory browsing</para></listitem> |
|
| <listitem><para>directory creating, renaming and removing</para></listitem> |
|
| <listitem><para>file creating, uploading, renaming, deleting and viewing</para></listitem> |
|
| <listitem><para>huge configuration ability to allow/deny appropriate actions</para></listitem> |
|
| <listitem><para>PostNuke Rogue add-on compatibility</para></listitem> |
|
| <listitem><para>multilanguage support</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="requirements"> |
|
| <title>Requirements</title> |
|
| <para> |
|
| |
|
| 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. |
|
| |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="supported-clients"> |
|
| <title>Supported clients</title> |
|
| <para> |
|
| |
|
| 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. |
|
| |
|
| </para> |
|
| </sect1> |
|
| </chapter> |
|
| <chapter id="usage"> |
|
| <title>Usage</title> |
|
| <sect1 id="installation"> |
|
| <title>Installation</title> |
|
| <para> |
|
| Unpack archive to some directory, which could be accessed from Web. |
|
| </para> |
|
| <para> |
|
| Change mode of created phpWebFileManager directory so it can be |
|
| accessed from Web. Command |
|
| </para> |
|
| <para> |
|
| <command> |
|
| chmod -R u=rwX,g-rwx,o=rX phpWebFileManager/ |
|
| </command> |
|
| </para> |
|
| <para> |
|
| will do the job. Installation is done. |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="configuration"> |
|
| <title>Configuration</title> |
|
| |
|
| <para> |
|
| Configuration variables are located in <filename>config.inc.php</filename> file. |
|
| </para> |
|
| |
|
| <sect2 id="configuration.original-variables-property"> |
|
| <title>Original variables property</title> |
|
| <para> |
|
| |
|
| Determine if you want to use phpWebFileManager as a standalone Web application |
|
| or you want to include it in some bigger project. |
|
| |
|
| </para> |
|
| <itemizedlist> |
|
| <listitem> |
|
| <para> |
|
| |
|
| If you want to use it as an standalone application, edit the config file and |
|
| ignore <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname> variable. |
|
| |
|
| </para> |
|
| </listitem> |
|
| <listitem> |
|
| <para> |
|
| |
|
| If you want to use as a part of some bigger project, edit the config file with |
|
| focusing on <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname>. |
|
| phpWebFileManager provides itself a lot of actions such as confirm of deletion |
|
| file and others. <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname> are |
|
| variables, which will phpWebFileManager keep, so each page reload will be |
|
| processed in right way by others components of your PHP script. |
|
| |
|
| </para> |
|
| <para> |
|
| |
|
| If <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname> 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 |
|
| <filename>phpWebFileManager.php</filename> file. |
|
| |
|
| </para> |
|
| </listitem> |
|
| </itemizedlist> |
|
| </sect2> |
|
| |
|
| <sect2 id="configuration.other-properties"> |
|
| <title>Other properties</title> |
|
| |
|
| <para> |
|
| |
|
| Than edit others variables in config file. More information about every |
|
| specific variable are described in <filename>config.inc.php</filename> file. |
|
| |
|
| </para> |
|
| </sect2> |
|
| |
|
| <sect2 id="configuration.file-upload"> |
|
| <title>File upload</title> |
|
| <para> |
|
| |
|
| If you want to provide file uploading, you must create world writeable |
|
| directory. Imagine that it is directory <filename |
|
| class=directory>upload/</filename>, so than run command |
|
| |
|
| </para> |
|
| <para> |
|
| |
|
| <command>chmod o+w upload/</command> |
|
| |
|
| </para> |
|
| <para> |
|
| to make it world writeable. |
|
| </para> |
|
| </sect2> |
|
| |
|
| <sect2 id="configuration.postnuke-compatibility"> |
|
| <title>PostNuke compatibility</title> |
|
| <para> |
|
| |
|
| Since version 0.2.2 phpWebFileManager has an ability to act as a PostNuke Rogue |
|
| module (add-on). |
|
| |
|
| </para> |
|
| <para> |
|
| |
|
| Simply copy the directory into <filename class=directory>modules/</filename> |
|
| 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. |
|
| |
|
| </para> |
|
| <para> |
|
| |
|
| 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. |
|
| |
|
| </para> |
|
| <para> |
|
| |
|
| PostNuke specific configuration is overriden in |
|
| <filename>init.inc.php</filename> 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. |
|
| |
|
| </para> |
|
| |
|
| </sect2> |
|
| |
|
| </sect1> |
|
| <sect1 id="running"> |
|
| <title>Running</title> |
|
| <para> |
|
| If you have edited config file and wanted phpWebFileManager as |
|
| a standalone application, try to access phpWebFileManager using some |
|
| web browser. |
|
| </para> |
|
| <para> |
|
| |
|
| If you want to run it as a part of some other web application, write |
|
| <function>include()</function> or <function>require()</function> command with |
|
| path and filename to file <filename>phpWebFileManager.php</filename> on the |
|
| place, where you want to have file manager. |
|
| |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="security-notes"> |
|
| <title>Security notes</title> |
|
| <para> |
|
| |
|
| If you want to secure phpWebFileManager, put security stuff commands or |
|
| <function>include()</function> command to security stuff script at the |
|
| beginning of config file. That file is loaded by |
|
| <filename>init.inc.php</filename> at the beggining of script execution. |
|
| |
|
| </para> |
|
| </sect1> |
|
| </chapter> |
|
| |
|
| <chapter id="others"> |
|
| <title>Other information</title> |
|
| |
|
| <sect1 id="license"> |
|
| <title>License</title> |
|
| <para> |
|
| Copyright (c) 2001-2002 Ondrej Jombik <email>nepto@pobox.sk</email> |
|
| </para> |
|
| <para> |
|
| 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. |
|
| </para> |
|
| <para> |
|
| 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. |
|
| </para> |
|
| <para> |
|
| 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. |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="request-to-users"> |
|
| <title>Request to users</title> |
|
| <para> |
|
| 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 address. |
|
| </para> |
|
| <para> |
|
| Likewise, if you don't find in <filename class=directory>language/</filename> 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. |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="author-and-homepage"> |
|
| <title>Author and homepage</title> |
|
| <para> |
|
| Author is Ondrej Jombik <email>nepto@pobox.sk</email>, <ulink url="http://nepto.sk/">http://nepto.sk/</ulink>. |
|
| </para> |
|
| <para> |
|
| Feel free to e-mail me any bug reports, suggestions and question |
|
| about this PHP script. |
|
| </para> |
|
| <para> |
|
| |
|
| The latest official release of phpWebFileManager is available from: <ulink |
|
| url="http://www.platon.sk/projects/phpWebFileManager/">http://www.platon.sk/projects/phpWebFileManager/</ulink> |
|
| |
|
| </para> |
|
| </sect1> |
|
| <sect1 id="history"> |
|
| <title>Version history</title> |
|
| |
|
| <para>Current version is 0.2.2 and it was released in 21st April 2002.</para> |
|
| |
|
| <para> |
|
| version 0.2.2, April 21, 2002 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para> |
|
| fixed PostNuke port, <filename>init.inc.php</filename> file created for initialization |
|
| </para></listitem> |
|
| <listitem><para> |
|
| new subdirectory <filename class=directory>lib/</filename> created for phpPlatonLib functions, |
|
| <filename>url_utils.lib.php</filename> file removed |
|
| </para></listitem> |
|
| <listitem><para> |
|
| various documentation update, Ken Kizaki's PN-MODULE-HOWTO added to distribution |
|
| </para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| Changes by Rastislav 'Rider' Rihak <email>rider@lonestar.sk</email>: |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>PostNuke Rogue port</para></listitem> |
|
| <listitem><para>new multilanguage support system</para></listitem> |
|
| <listitem><para>startup redirection file <filename>index.php</filename> removed</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| |
|
| <para> |
|
| version 0.2.1, March 25, 2002 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>ability to overide date format in config file</para></listitem> |
|
| <listitem><para>support for enable/disable icons displaying</para></listitem> |
|
| <listitem><para>all variables were uncommented in config file to prevent its initialization from CGI environment</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| Changes by Ken Kizaki <email>ken_kizaki@yahoo.co.jp</email> and Daniel Fernandez <email>funkyferdy@econophone.ch</email>: |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>german translation</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| Changes by Greg Baker <email>ggbaker@cs.sfu.ca</email>: |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>file size and last modification date support</para></listitem> |
|
| <listitem><para>date format in language translation files</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| |
|
| <para> |
|
| version 0.2, February 21, 2002 (official release) |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem> |
|
| <para> |
|
| several features have been implemented, phpWebFileManager seems |
|
| to be stable now, although according to TODO list, new things |
|
| will be added soon |
|
| </para> |
|
| </listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| |
|
| <para> |
|
| version 0.1.8, February 16, 2002 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>multilanguage support</para></listitem> |
|
| <listitem><para>english and slovak translation added</para></listitem> |
|
| <listitem><para>ability to deny symbolic links following</para></listitem> |
|
| <listitem><para>add striping slashes from CGI variables to properly handle |
|
| directories with quotation characters</para></listitem> |
|
| <listitem><para>quoted value parameters of all input tag</para></listitem> |
|
| <listitem><para>HTML validity improvements</para></listitem> |
|
| <listitem><para>documentation changes</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.7, December 18, 2001 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>added parameters into config file to specify background color |
|
| of even and odd rows</para></listitem> |
|
| <listitem><para><varname>fm_</varname> prefix for CGI variables to avoid variable name collisions |
|
| in large projects</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.6, October 24, 2001 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>finally valid handling of all file and directory names (with spaces, |
|
| ampersands, quotes, etc) and also valid HTML references (links) |
|
| creating using appropriate functions <function>urlencode()</function> and <function>htmlentities()</function></para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.5, October 1, 2001 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>added <varname>$phpWebFileManager_LINKS_PREFIX</varname> parameter to build links for View feature; |
|
| if it is not present HTML links are built in standart way</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.4, September 26, 2001 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>added ability to allow user to turn on/off View/Enter, Rename |
|
| Delete/Remove and Create/Upload functionality with focus |
|
| on security</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.3, August 23, 2001 |
|
| </para> |
|
| <para> |
|
| Changes by Paul Grace <email>paulgrace@telstra.com</email>: |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>directories with spaces handling</para></listitem> |
|
| <listitem><para>alphabetical directory sorting</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.2, July 31, 2001 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>documentation and TODO list update</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1.1, July 27, 2001 |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>change relative redirect to absolute in <filename>index.php</filename> (RFC2068)</para></listitem> |
|
| <listitem><para>fixing file view</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| <para> |
|
| version 0.1, July 22, 2001 (official release) |
|
| </para> |
|
| <para> |
|
| <itemizedlist> |
|
| <listitem><para>initial release</para></listitem> |
|
| </itemizedlist> |
|
| </para> |
|
| </sect1> |
|
| </chapter> |
|
| |
|
| </book> |
</book> |
| |
|