Vanilla 1 Documentation Archive

 
 
filebrowser:docs
Table of Contents

Filebrowser Documentation

About the Filebrowser & Licensing

What is the Filebrowser?

The Filebrowser came into being around 1999 as an ASP (Active Server Pages) script that was used to navigate around random files dumped in a directory. At the time there were very few scripts of this type for windows-based servers, so Mark decided to fill the gap. Mark has since moved away from Windows servers in general, and so the Filebrowser has evolved into a PHP-based script that does much the same thing as the older version (with a few extra bells & whistles). The Filebrowser’s primary use is a nice easy way of navigating through your “image dump folders” online.

Getting the Filebrowser

The latest version of the Filebrowser can be downloaded from http://thefilebrowser.com. Be sure to check back occasionally for newer versions of the Filebrowser, and sign up to the mailing list (located at the bottom of the page at thefilebrowser.com) to be notified of any new releases.

About Copyrights and Software Licenses

Lussumo Software is 100% GPL (General Public License); if yours is 100% GPL compliant, then you have no obligation to pay for the licenses. The formal terms of the GPL license can be found on the Free Software Foundation site.

Specifically: Lussumo Software is free to use for those who are 100% GPL. If your application is licensed under GPL or compatible OSI license, you are free to ship any Lussumo Software with your application (’application’ means any type of software application, system, tool or utility). You do not need a separate signed agreement with Lussumo Software, because the GPL license is sufficient. Under the Open Source License, you must release the complete source code for the application that is built using Lussumo Software. You are allowed to modify Lussumo Software source code any way you like as long as the distributed derivative work is licensed under the GPL as well. You are allowed to copy Lussumo Software source code, but when you do so, the copies will fall under the GPL license.

To anyone in doubt, we recommend that you contact us by email at support@lussumo.com about obtaining a commercial license.

System Requirements

Filebrowser Requirements

The Filebrowser is written in PHP, and is believed to work with all versions greater than 4.0. If you are running a version of PHP greater than 4.0 and you encounter errors, please report them. PHP is available for both Linux/Unix & Windows based servers (don’t let those ignorant tech support people tell you otherwise). If you are unsure of whether or not your web server runs PHP:

  1. Create a blank text file
  2. Open & edit the file, adding the following text:
    <? phpinfo(); ?>
  3. Save the file
  4. Rename the file test.php
  5. Upload the file to your server and view in your web browser

If your web server is running PHP, you should see a full page of information about what version of PHP your server is running.

Thumbnailer Requirements

The Lussumo Thumbnailer requires the GD2 library and a version of PHP greater than or equal to 4.3.0.

Permissions

The Filebrowser requires that PHP have read access to the lussumo configuration files. The Lussumo Thumbnailer requires that PHP have read and write access to the folder in which you want to generate thumbnails.

Filebrowser Files

The Filebrowser comes with the following files:

File Name Description
_clipboard.swf Flash Movie file used to allow for copying urls to your clipboard by clicking a link on a page (Big thank you to Sean Christman for this functionality).
_config.xml Configuration file used to define various look, feel, and functional elements of the Filebrowser.
_corner_br.gif, _corner_tl.gif Images used to pretty up the Filebrowser. You do not need these files if you don’t want them.
_default.css Cascading Stylesheet. Fully defines appearance of the Filebrowser.
_filetypes.xml Configuration file used to define how files are sorted and handled.
index.php Filebrowser Source File. You can rename this file to whatever you want.
_thumbnailer.css Cascading Stylesheet. Fully defines appearance of the Thumbnailer.
thumbnailer.php Thumbnailer Source File. This file will be hidden by the Filebrowser by default.
gpl.txt A copy of the General Public License agreement

Installation

Directory Placement

There are no specific rules about where you should place the Filebrowser source files other than to say that (obviously) they should be in a web-accessible folder on your server. All files need to be in the same folder. If you have subfolders and you have directory browsing enabled in the Filebrowser configuration file, you do not need to copy the Filebrowser source files into the subdirectories - it can navigate the directory tree from its root folder.

_config.xml

The _config.xml file is used to configure how your Filebrowser should appear and operate. There absolutely *must* be a copy of the _config.xml file in the root directory (the directory where the index.php file resides). You may also supply _config.xml files in subdirectories if you wish for the subdirectories to appear or operate in a different manner than the root directory. For example: if you wish each subfolder to have its own introductory message.

The configuration file contains the following parameters:

Parameter Description
PageTitle The page title will appear on the title bar of your browser and on the top-left of the page. You may provide any alpha-numeric collection of characters. HTML characters such as < and > will cause the xml file to malfunction.
PageIntroduction The page introduction is the message that appears on the page before any files are viewed. You may provide any alpha-numeric collection of characters. Angle brackets < and > will cause the xml file to malfunction, but you can substitute square brackets [ and ] in their place and they will be converted to angle brackets when displayed in the page (Allowing you to write html in your page introductions).
BrowseSubFolders The Filebrowser has the ability of enabling the user to traverse the directories below the root directory in which your Filebrowser files reside. If you wish for subdirectories to remain hidden, you may disable this feature here. Allowed values are “true” or “false”.
DateFormat Although the default stylesheet has made file creation dates invisible, you can make them visible by modifying the stylesheet or creating your own. The format of the date can then be defined using this setting. For full details on date formatting in PHP and examples of the types of entries that can be used in this parameter, visit the PHP.net man pages for date formatting: http://www.php.net/manual/en/function.date.php
DisplayHiddenFiles The Filebrowser treats files prefixed with an underscore _ as “hidden”. If you wish to disable this exclusion, you may do so here. Allowed values are “true” or “false”
FilesPerPage The Filebrowser enables the user to define how many files they view per page. This value is the default that is used before the user changes it. You can specify any integer here.
FitImagesToPage The Filebrowser has the ability to detect the user’s window size and shrink images to fit in the user’s window automatically. If this feature is enabled, the user will be able to click a link to resize the image to it’s actual dimensions. To disable this feature, set this value to false. Allowed values are “true” or “false”.
HideFiles If there are particular files that you do not want to prefix with the underscore _ to hide and you do not want displayed in the Filebrowser, you can add them here in a comma delimited list.
MaxFilesPerPage The Filebrowser enables the user to define how many files they view per page. This value is the maximum amount that a user can enter. So, if you set this value to 100, and a user tried to view 120 per page, it would cut the number back to 100.
MaxThumbHeight & MaxThumbWidth You can set the size of your thumbnail images here. The images generated by the Thumbnailer will retain their original aspect ratio and just fit within the dimensions defined here. You can specify any integer.
PluginHeight & PluginWidth Some media plugins (Flash Movies, Media Files, etc) require that height and width parameters be supplied, or they will not display correctly. You can provide those parameters here. You can specify any integer.
SortBy Files in each folder can be sorted by name, size, or date. Allowed values are “Name”, “Size”, or “Date”.
SortDirection Files in each folder can be sorted in ascending or descending order. This value will also sort folders by name in the order defined.
StyleUrl This is the path where your stylesheet for the Filebrowser resides. You can manipulate the stylesheet that comes with the Filebrowser, or you can create your own entirely new stylesheet and point to it here. You can also have multiple stylesheets and use different ones from each configuration file in each subfolder. You may provide any relevant relative folder path to a cascading stylesheet.
ThumbnailerStyleUrl This is the path where your stylesheet for the Thumbnailer resides. You can manipulate the stylesheet that comes with the Filebrowser, or you can create your own entirely new stylesheet and point to it here. You may provide any relevant relative folder path to a cascading stylesheet.
UsePageIntroductionInSubFolders If you choose to have one single _config.xml file in the root directory, but have directory browsing enabled, the same PageIntroduction message will appear in each subfolder whenever a user clicks into it. Using this parameter, you can make the Filebrowser display no PageIntroduction in subfolders. Allowed values are “true” or “false”.
UseThumbnails If this option is turned on, any image that has a thumbnail will display it in the file list of the Filebrowser. If you don’t want to use thumbnails, just set this value to false. Allowed values are “true” or “false”.

_filetypes.xml

The _filetypes.xml file is used to configure how files are grouped and handled. There absolutely *must* be a copy of the _filetypes.xml file in the root directory (the directory where the index.php file resides).

The filetypes file contains various “FileGroups”, and within each group it contains extension definitions and handler methods.

Each FileGroup can be given a name using the “Name” attribute of the FileGroup tag. This name will appear above each group of files which fall under that category. For example:

<FileGroup Name="Images">

is a FileGroup named “Images”. Any files with extensions that appear in this filegroup will be grouped under the “Images” heading when displayed on the page.

Each FileGroup can contain as many or as few extension definitions as you wish. An extension definition is a way of grouping files with different file extensions to be handled in a particular way. For example:

<Extensions HandlerMethod="Image">jpg,jpe,jpeg,gif,bmp,png</Extensions>

is an Extension group which handles any file with one of the extensions in the comma delimited list - in this case, images of any kind. The HandlerMethod defined in this example is “Image”, which will cause any of those files to be placed in an HTML img tag when appearing on the page.

There are seven different handler methods, as define below:

Handler Method Description
Image The file will be placed on the page in an img tag.
IFrame The file will be placed on the page in an iframe tag. This is suitable for text & html documents.
TextArea The file will be opened, parsed, and placed within a textarea. This is suitable for when you have a file whose contents you want to have displayed, like the source code of a PHP file.
EmbedFlash The file will be placed on the page in an embed tag specifically used for Flash SWF movie files.
Embed The file will be placed on the page in a standard embed tag. This is suitable for various multimedia files.
Default The file is simply hyperlinked.

Problems & Support

Getting More Help

If you did not find the answers you were looking for in this document, you can visit the Community Support Forum to ask for help.

Reporting Bugs

We are working on a bug tracker right now. In the meantime, please check for bugs at the Community Support Forum before using the bug report form at the bottom-right of every page of the forum.

Keeping up to Date

There is a mailing list available on http://thefilebrowser.com where you can sign up and be notified by email when updates and new software are released.

 
 
 
 
filebrowser/docs.txt · Last modified: 2009/03/28 14:10
Vanilla 1 Documentation archive (Wiki by DokuWiki)