| version 1.2, 2002/03/25 14:35:16 |
version 1.3, 2002/03/25 14:35:52 |
|
|
| <!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ |
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> |
| ]> |
<!-- $Id$ --> |
| |
<!-- |
| |
|
| |
Blbosti v DocBooku: |
| |
|
| |
1. <para> musi byt v <listitem> |
| |
2. <author> nema povoleny <email> |
| |
3. element <p> undefined - to mam vzdy vypisovat <para>? |
| |
4. value of attribute "CLASS" cannot be "CONFIGFILE"; |
| |
must be one of "HEADERFILE", "SYMLINK", "DIRECTORY" |
| |
preco nemoze byt napr configfile? kto vymyslal tie kategorie? |
| |
5. Nejako nie je doriesene to, ze kto je autor dokumentu a kto autor softveru o ktorom pisem. |
| |
6. Vrchol drzostri je, ze nemzoem v texte pouzit tagy <year>, <date>, <firstname>, <lastname> |
| |
7. Ako prinutit <ulink> otvarat link v novom okne? |
| |
|
| |
--> |
| |
|
| <book id="phpwebfilemanager-manual"> |
<book id="phpwebfilemanager-manual"> |
| <bookinfo> |
<bookinfo> |
|
|
| <surname>Jombík</surname> |
<surname>Jombík</surname> |
| </author> |
</author> |
| </authorgroup> |
</authorgroup> |
| |
<copyright> |
| |
<year>2000</year> |
| |
<year>2001</year> |
| |
<holder>Ondrej 'Nepto' Jombík</holder> |
| |
</copyright> |
| </bookinfo> |
</bookinfo> |
| |
|
| |
|
|
|
| <title>Overview</title> |
<title>Overview</title> |
| <para> |
<para> |
| phpWebFileManager is simple file management PHP tool. It is designed |
phpWebFileManager is simple file management PHP tool. It is designed |
| for including in large projects using include() or similar function. |
for including in large projects using <function>include()</function> or similar function. |
| </para> |
</para> |
| </sect1> |
</sect1> |
| <sect1 id="features"> |
<sect1 id="features"> |
| <title>Features</title> |
<title>Features</title> |
| <para> |
<para> |
| - secure directory browsing |
<itemizedlist mark=opencircle> |
| - directory creating, renaming and removing |
<listitem><para>secure directory browsing</para></listitem> |
| - file creating, uploading, renaming, deleting and viewing |
<listitem><para>directory creating, renaming and removing</para></listitem> |
| - huge configuration ability to allow/deny appropriate actions |
<listitem><para>file creating, uploading, renaming, deleting and viewing</para></listitem> |
| - multilanguage support |
<listitem><para>huge configuration ability to allow/deny appropriate actions</para></listitem> |
| |
<listitem><para>multilanguage support</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| </sect1> |
</sect1> |
| <sect1 id="requirements"> |
<sect1 id="requirements"> |
| Line 68 Change mode of created phpWebFileManager |
|
| Line 90 Change mode of created phpWebFileManager |
|
| accessed from Web. Command |
accessed from Web. Command |
| </para> |
</para> |
| <para> |
<para> |
| chmod -R u=rwX,g-rwx,o=rX phpWebFileManager/ |
<command> |
| |
chmod -R u=rwX,g-rwx,o=rX phpWebFileManager/ |
| |
</command> |
| </para> |
</para> |
| <para> |
<para> |
| will do the job. Installation is done. |
will do the job. Installation is done. |
| Line 77 will do the job. Installation is done. |
|
| Line 101 will do the job. Installation is done. |
|
| <sect1 id="configuration"> |
<sect1 id="configuration"> |
| <title>Configuration</title> |
<title>Configuration</title> |
| <para> |
<para> |
| Edit variables in config.inc.php file. |
Edit variables in <filename>config.inc.php</filename> file. |
| </para> |
</para> |
| <para> |
<para> |
| Determine if you want to use phpWebFileManager as a standalone Web |
|
| application or you want to include it in some bigger project. |
Determine if you want to use phpWebFileManager as a standalone Web application |
| |
or you want to include it in some bigger project. |
| |
|
| </para> |
</para> |
| |
<itemizedlist> |
| |
<listitem> |
| <para> |
<para> |
| 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 it as an standalone application, edit the config file and |
| |
ignore <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname> variable. |
| |
|
| </para> |
</para> |
| |
</listitem> |
| |
<listitem> |
| <para> |
<para> |
| If you want to use as a part of some bigger project, edit the config |
|
| file with focusing on $phpWebFileManager_ORIGINAL_VARIABLES. |
If you want to use as a part of some bigger project, edit the config file with |
| phpWebFileManager provides itself a lot of actions such as confirm of |
focusing on <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname>. |
| deletion file and others. $phpWebFileManager_ORIGINAL_VARIABLES are |
phpWebFileManager provides itself a lot of actions such as confirm of deletion |
| variables, which will phpWebFileManager keep, so each page reload |
file and others. <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname> are |
| will be processed in right way by others components of your |
variables, which will phpWebFileManager keep, so each page reload will be |
| PHP script. |
processed in right way by others components of your PHP script. |
| |
|
| </para> |
</para> |
| <para> |
<para> |
| If $phpWebFileManager_ORIGINAL_VARIABLES is not constant, you can |
|
| comment it out in config file and always set it in your main program |
If <varname>$phpWebFileManager_ORIGINAL_VARIABLES</varname> is not a constant, |
| to the right value before doing command which will include |
you can comment it out in config file and always set it in your main program to |
| phpWebFileManager.php file. |
the right value before doing command which will include |
| |
<filename>phpWebFileManager.php</filename> file. |
| |
|
| </para> |
</para> |
| |
</listitem> |
| |
</itemizedlist> |
| <para> |
<para> |
| If you want to provide file uploading, you must create world |
|
| writeable directory. Imagine that it is directory upload/, so than |
If you want to provide file uploading, you must create world writeable |
| run command |
directory. Imagine that it is directory <filename |
| |
class=directory>upload/</filename>, so than run command |
| |
|
| </para> |
</para> |
| <para> |
<para> |
| chmod o+w upload/ |
|
| |
<command>chmod o+w upload/</command> |
| |
|
| </para> |
</para> |
| <para> |
<para> |
| to make it world writeable. |
to make it world writeable. |
| </para> |
</para> |
| <para> |
<para> |
| Than edit others variables in config file. More informations about |
|
| every specific variable are in config.inc.php file. |
Than edit others variables in config file. More informations about every |
| |
specific variable are described in <filename>config.inc.php</filename> |
| |
file. |
| |
|
| </para> |
</para> |
| </sect1> |
</sect1> |
| <sect1 id="running"> |
<sect1 id="running"> |
| Line 126 a standalone application, try to access |
|
| Line 170 a standalone application, try to access |
|
| web browser. |
web browser. |
| </para> |
</para> |
| <para> |
<para> |
| |
|
| If you want to run it as a part of some other web application, write |
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 |
<function>include()</function> or <function>require()</function> command with |
| phpWebFileManager.php on the place, where you want to have file |
path and filename to file <filename>phpWebFileManager.php</filename> on the |
| manager. |
place, where you want to have file manager. |
| |
|
| </para> |
</para> |
| </sect1> |
</sect1> |
| <sect1 id="security-notes"> |
<sect1 id="security-notes"> |
| <title>Security notes</title> |
<title>Security notes</title> |
| <para> |
<para> |
| If you want to secure phpWebFileManager put security stuff commands |
If you want to secure phpWebFileManager put security stuff commands |
| or include() command to security stuff script at the beginning |
or <function>include()</function> command to security stuff script at the beginning |
| of config file. |
of config file. |
| </para> |
</para> |
| </sect1> |
</sect1> |
|
|
| <sect1 id="license"> |
<sect1 id="license"> |
| <title>License</title> |
<title>License</title> |
| <para> |
<para> |
| Copyright (c) 2001-2002 Ondrej Jombik <nepto@pobox.sk> |
Copyright (c) 2001-2002 Ondrej Jombík <email>nepto@pobox.sk</email> |
| </para> |
</para> |
| <para> |
<para> |
| This program is free software; you can redistribute it and/or modify |
This program is free software; you can redistribute it and/or modify |
| Line 178 Comments, suggestions, bug reports and p |
|
| Line 224 Comments, suggestions, bug reports and p |
|
| Please e-mail them to the following address. |
Please e-mail them to the following address. |
| </para> |
</para> |
| <para> |
<para> |
| Likewise, if you don't find in language/ subdirectory a translation |
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 |
into your language, you can make one. But firstly ask me, if that |
| translation is not already made, because you could not have actual |
translation is not already made, because you could not have actual |
| version of phpWebFileManager. |
version of phpWebFileManager. |
| Line 187 version of phpWebFileManager. |
|
| Line 233 version of phpWebFileManager. |
|
| <sect1 id="author-and-homepage"> |
<sect1 id="author-and-homepage"> |
| <title>Author and homepage</title> |
<title>Author and homepage</title> |
| <para> |
<para> |
| Author is Ondrej Jombik <nepto@pobox.sk>. |
Author is Ondrej Jombik <email>nepto@pobox.sk</email>, <ulink url="http://nepto.sk/">http://nepto.sk/</ulink>. |
| </para> |
</para> |
| <para> |
<para> |
| Feel free to e-mail me any bug reports, suggestions and question |
Feel free to e-mail me any bug reports, suggestions and question |
| about this PHP script. |
about this PHP script. |
| </para> |
</para> |
| <para> |
<para> |
| The latest official release of phpWebFileManager is available from: |
|
| http://www.platon.sk/projects/phpWebFileManager/ |
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> |
</para> |
| </sect1> |
</sect1> |
| <sect1 id="history"> |
<sect1 id="history"> |
| <title>Version history</title> |
<title>Version history</title> |
| |
|
| |
<para> |
| |
Current version is 0.2.1 and it was released in 25th March 2001. |
| |
</para> |
| |
|
| |
<para> |
| |
version 0.2.1, March 25, 2002 |
| |
</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> |
<para> |
| Current version is 0.2 and it was released in 21st February 2001. |
<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> |
| <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> |
| version 0.2, February 21, 2002 (official release) |
version 0.2, February 21, 2002 (official release) |
| </para> |
</para> |
| <para> |
<para> |
| - several features have been implemented, phpWebFileManager seems |
<itemizedlist> |
| to be stable now, although according to TODO list, new things |
<listitem> |
| will be added soon |
<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> |
| |
|
| <para> |
<para> |
| version 0.1.8, February 16, 2002 |
version 0.1.8, February 16, 2002 |
| </para> |
</para> |
| <para> |
<para> |
| - multilanguage support |
<itemizedlist> |
| - english and slovak translation added |
<listitem><para>multilanguage support</para></listitem> |
| - ability to deny symbolic links following |
<listitem><para>english and slovak translation added</para></listitem> |
| - add striping slashes from CGI variables to properly handle |
<listitem><para>ability to deny symbolic links following</para></listitem> |
| directories with quotation characters |
<listitem><para>add striping slashes from CGI variables to properly handle |
| - quoted value parameters of all input tag |
directories with quotation characters</para></listitem> |
| - HTML validity improvements |
<listitem><para>quoted value parameters of all input tag</para></listitem> |
| - documentation changes |
<listitem><para>HTML validity improvements</para></listitem> |
| |
<listitem><para>documentation changes</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| <para> |
<para> |
| version 0.1.7, December 18, 2001 |
version 0.1.7, December 18, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| - added parameters into config file to specify background color |
<itemizedlist> |
| of even and odd rows |
<listitem><para>added parameters into config file to specify background color |
| - 'fm_' prefix for CGI variables to avoid variable name collisions |
of even and odd rows</para></listitem> |
| in large projects |
<listitem><para><varname>fm_</varname> prefix for CGI variables to avoid variable name collisions |
| |
in large projects</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| <para> |
<para> |
| version 0.1.6, October 24, 2001 |
version 0.1.6, October 24, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| - finally valid handling of all file and directory names (with spaces, |
<itemizedlist> |
| |
<listitem><para>finally valid handling of all file and directory names (with spaces, |
| ampersands, quotes, etc) and also valid HTML references (links) |
ampersands, quotes, etc) and also valid HTML references (links) |
| creating using appropriate functions urlencode() and htmlentities() |
creating using appropriate functions <function>urlencode()</function> and <function>htmlentities()</function></para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| <para> |
<para> |
| version 0.1.5, October 1, 2001 |
version 0.1.5, October 1, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| - added LINKS_PREFIX parameter to build links for View feature; |
<itemizedlist> |
| if it is not present HTML links are built in standart way |
<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> |
| <para> |
<para> |
| version 0.1.4, September 26, 2001 |
version 0.1.4, September 26, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| - added ability to allow user to turn on/off View/Enter, Rename |
<itemizedlist> |
| |
<listitem><para>added ability to allow user to turn on/off View/Enter, Rename |
| Delete/Remove and Create/Upload functionality with focus |
Delete/Remove and Create/Upload functionality with focus |
| on security |
on security</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| <para> |
<para> |
| version 0.1.3, August 23, 2001 |
version 0.1.3, August 23, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| Changes by Paul Grace <paulgrace@telstra.com> |
Changes by Paul Grace <email>paulgrace@telstra.com</email>: |
| </para> |
</para> |
| <para> |
<para> |
| - directories with spaces handling |
<itemizedlist> |
| - alphabetical directory sorting |
<listitem><para>directories with spaces handling</para></listitem> |
| |
<listitem><para>alphabetical directory sorting</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| <para> |
<para> |
| version 0.1.2, July 31, 2001 |
version 0.1.2, July 31, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| - documentation & TODO list update |
<itemizedlist> |
| |
<listitem><para>documentation and TODO list update</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| <para> |
<para> |
| version 0.1.1, July 27, 2001 |
version 0.1.1, July 27, 2001 |
| </para> |
</para> |
| <para> |
<para> |
| - change relative redirect to absolute in index.php (RFC2068) |
<itemizedlist> |
| - fixing file view |
<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> |
| <para> |
<para> |
| version 0.1, July 22, 2001 (official release) |
version 0.1, July 22, 2001 (official release) |
| </para> |
</para> |
| <para> |
<para> |
| - initial release |
<itemizedlist> |
| |
<listitem><para>initial release</para></listitem> |
| |
</itemizedlist> |
| </para> |
</para> |
| </sect1> |
</sect1> |
| </chapter> |
</chapter> |