rich-filemanager
Advanced tools
Rich Filemanager is an open-source file manager released under MIT license. Based on the simogeo Filemanager, with a lot of improvements and new features.
Filemanager live example: http://fm.16mb.com/
Filemanager was initially designed to interact with a number of programming languages via connectors. But since many changes have been done recently, only PHP connector is the only actual connector currently. Compatibility with other connectors is most likely completely broken. You are still able you to download unsupported v0.8 from archive (PHP, ASHX, ASP, CFM, lasso, PL and JSP)
Any contribution is greatly appreciated. You can become a maintainer for any of existent connectors, or create new one for your server side language. Check the details in API section.
Filemanager is highly documented on the wiki pages. API, see below.
(1) Check out a copy of the Rich Filemanager from the repository using Git:
git clone http://github.com/servocoder/RichFilemanager.git
or download the archive from Github : https://github.com/servocoder/RichFilemanager/archive/master.zip
You can place the FileManager anywhere within your web serving root directory.
(2) Make a copy of the default configuration file ("filemanager.config.default.json" located in the scripts directory), removing the '.default' from the end of the filename, and edit the options according to the following wiki page : https://github.com/servocoder/RichFilemanager/wiki/Filemanager-configuration-file Having a look on configuration cases study may also be helpful to you : https://github.com/servocoder/RichFilemanager/wiki/Specify-user-folder%2C-configuration-cases
(3a) If you are integrating the FileManager with FCKEditor, open your fckconfig.js file and find the lines which specify what file browser to use for images, links, etc. Look toward the bottom of the file. You will need to change lines such as this:
FCKConfig.ImageBrowser = false ;
FCKConfig.ImageBrowserURL = FCKConfig.BasePath + 'filemanager/browser/default/browser.html?Type=Image&Connector=../../connectors/' + _FileBrowserLanguage + '/connector.' + _FileBrowserExtension ;
...to this:
FCKConfig.ImageBrowser = true ;
FCKConfig.ImageBrowserURL = '[Path to Filemanager]/index.html' ;
(3b) If you are integrating the FileManager with CKEditor 3.x or higher, simply set the URL when you configure your instance, like so:
CKEDITOR.replace('instancename', {
filebrowserBrowseUrl: '[Path to Filemanager]/index.html',
...other configuration options...
});
If you want to use the modal dialog mode (instead of pop-up), please refer to the dedicated wiki page.
(3c) If you are integrating the FileManager with TinyMCE (>= 3.0), you should:
Create a Javascript callback function that will open the FileManager index.html base page (see URL below for examples) Add a line like: "file_browser_callback : 'name_of_callback_function'" in the tinyMCE.init command See http://www.tinymce.com/wiki.php/TinyMCE3x:How-to_implement_a_custom_file_browser for more details.
See also the dedicated wiki page, with TinyMCE 4 sample : https://github.com/servocoder/RichFilemanager/wiki/How-to-use-the-Filemanager-with-tinyMCE-3-or-4
(4) Last but not least, worry about security!
For PHP connector : setup /connectors/php/filemanager.php to define your own authentication function.
To do so, you will find an example on the dedicated wiki page.
(optional) Check /connectors/php/config.php to enable desired plugin or setup some server-side related settings.
jQuery dependency and compatibility
We try to keep updating jQuery core library regularly. If, for any reason, you can't use the embedded jQuery version just now that the Filemanager will probably work with a jQuery version >= 1.6. You'll have to use the jQuery.migrate() plugin to use it with jQuery version 1.9+.
Important : The Filemanager is designed to work without any special configuration but using it without any configuration is VERY unsafe. Please set-up your own authentication function, based on default file and refering to the dedicated wiki page.
You can create a connector for your server side language of choice by following this simple API. You must have a script at the following location which can respond to HTTP GET requests by returning an appropriate JSON object:
[path to FileManager]/connectors/[language extension]/filemanager.[language extension]
Rich Filemanager currently includes connectors for PHP, MVC, JSP, lasso, ASP, ASHX, PL and CFM in the following locations:
PHP: .../connectors/php/filemanager.php
ASP.NET MVC Framework .../connectors/mvc/FilemanagerController.cs
JSP: .../connectors/jsp/filemanager.jsp
lasso: .../connectors/lasso/filemanager.lasso
ASP: .../connectors/asp/filemanager.asp
ASHX: .../connectors/ashx/filemanager.asp
PL: .../connectors/pl/filemanager.pl
CFM: .../connectors/cfm/filemanager.cfm
As long as a script exists at this location to respond to requests, you may split up the code (external libraries, configuration files, etc.) however you see fit.
Every response should include two keys specific to error handling: Error, and Code. If an error occurs in your script, you may populate these keys with whatever values you feel are most appropriate. If there is no error, Error should remain empty or null, and Code should be empty, null, or zero (0). Do not use zero for any actual errors. The following example would be an appropriate response if the connector uses an external file for configuration (recommended), but that file cannot be found:
{
"Error": "Configuration file missing.",
"Code": -1
}
Your script should include support for the following methods/functions. GET requests from Rich Filemanager include a parameter "mode" which will indicate which type of response to return. Additional parameters will provide other information required to fulfill the request, such as the current directory.
The getinfo method returns information about a single file.
Requests with mode "getinfo" will include an additional parameter, "path", indicating which file to inspect.
Example Request:
[path to connector]?mode=getinfo&path=/userfiles/images/logo.png
Example Response:
{
"Path": "/userfiles/images/logo.png",
"Filename": "logo.png",
"File Type": "png",
"Thumbnail": "/connectors/[lang]/filemanager.[lang]?mode=getimage&path=%2Flogo.png&time=1463130804&thumbnail=true",
"Preview": "http://site.com/userfiles/images/logo.png",
"Protected": 0,
"Properties": {
"Date Created": null,
"Date Modified": "02/09/2007 14:01:06",
"filemtime": 1360237058,
"Height": 14,
"Width": 14,
"Size": 384
},
"Error": "",
"Code": 0
}
The keys are as follows:
Path: The path to the file. Should match what was passed in the request.
Filename: The name of the file, i.e., the last part of the path.
File Type: The file extension, "dir" if a directory, or "txt" if missing/unknown.
Thumbnail: Path to an image thumbnail. If the file is an image that can be displayed in a web browser (i.e., gif, jpg, or png), you should return the path to the image. Otherwise, check to see if there is a matching file icon based on the file extension, constructing the path like so:
Directories: images/fileicons/_Open.png
Files: images/fileicons/[extension].png
Unknown: images/fileicons/default.png
Preview: Path or full URL (depends on viewer) to a file that supposed to be displayed with one of viewers:
ViewerJS, HTML5 audio/video: local path to file
Google Docs Viewer: absolute full URL to file
Protected: Indicates if the file has some reading / writing restrictions. If not, set to 0. Else set to 1.
Properties: A nested JSON object containing specific properties of the file.
Date Created: The file's creation date, if available.
Date Modified: The file's modification date, if available.
filemtime: The file's modification timestamp, if available.
Height: If an image, the height in pixels.
Width: If an image, the width in pixels.
Size: The file size in bytes.
Capabilities (optional): You can limit the operation buttons shown for a specific file. It is an array containing ['select','delete','rename','download'] (for all capabilities), or [] (for no capabilities). If not present, all capabilities are enabled.
Error: An error message, or empty/null if there was no error.
Code: An error code, or 0 if there was no error.
The getfolder method returns an array of file and folder objects representing the contents of the given directory (indicated by a "path" parameter). It should call the getinfo method to retrieve the properties of each file. "Preview" property may be omitted for the current method.
Optionally a "type" parameter can be specified to restrict returned files (depending on the connector). If a "type" parameter is given for the main index.html URL, the same parameter value is reused and passed to getfolder. This can be used for example to only show image files in a file system tree.
Example Request:
[path to connector]?mode=getfolder&path=/UserFiles/Image/&getsizes=true&type=images
Example Response:
{
"/userfiles/audio.mp3": {
"Path": "/userfiles/audio.mp3",
"Filename": "audio.mp3",
"File Type": "mp3",
"Thumbnail": "/images/fileicons/mp3.png",
"Protected": 0,
"Properties": {
"Date Created": null,
"Date Modified": "05/05/2016 11:38:42",
"filemtime": 1462441126,
"Height": 0,
"Width": 0,
"Size": 384
},
"Error": "",
"Code": 0
},
"/userfiles/images/logo.png": {
"Path": "/userfiles/images/logo.png",
"Filename": "logo.png",
"File Type": "png",
"Thumbnail": "/connectors/[lang]/filemanager.[lang]?mode=getimage&path=%2Flogo.png&time=1463130804&thumbnail=true",
"Protected": 0,
"Properties": {
"Date Created": null,
"Date Modified": "05/05/2016 11:38:42",
"filemtime": 1462441126,
"Height": 14,
"Width": 14,
"Size": 384
},
"Error": "",
"Code": 0
},
"/userfiles/folder/":{
"Path": "/userfiles/folder/",
"Filename": "folder",
"File Type": "dir",
"Thumbnail": "images/fileicons/_Open.png",
"Properties": {
"Date Created": null,
"Date Modified": "05/05/2016 11:38:42",
"filemtime": 1462441126,
"Height": 0,
"Width": 0,
"Size": 0
},
"Error":"",
"Code":0
}
}
Each key in the array is the path to an individual item, and the value is the file object for that item.
The add method adds the uploaded file to the specified path. Unlike the other methods, this method must return its JSON response wrapped in an HTML <textarea>, so the MIME type of the response is text/html instead of text/plain. The upload form in the File Manager passes the current path as a POST param along with the uploaded file. The response includes the path as well as the name used to store the file. The uploaded file's name should be safe to use as a path component in a URL, so URL-encoded at a minimum.
Example Response:
{
"Path": "/userfiles/images/",
"Name": "new_logo.png",
"Error": "No error",
"Code": 0
}
The addfolder method creates a new directory on the server within the given path.
Example Request:
[path to connector]?mode=addfolder&path=/userfiles/&name=new%20logo.png
Example Response:
{
"Parent": "/userfiles/",
"Name": "new_logo.png",
"Error": "No error",
"Code": 0
}
The rename method renames the item at the path given in the "old" parameter with the name given in the "new" parameter and returns an object indicating the results of that action.
Example Request:
[path to connector]?mode=rename&old=/userfiles/images/logo.png&new=id.png
Example Response:
{
"Error": "No error",
"Code": 0,
"Old Path": "/a_folder_renamed/thisisareallylongincrediblylongfilenamefortesting.txt",
"Old Name": "thisisareallylongincrediblylongfilenamefortesting.txt",
"New Path": "/a_folder_renamed/a_renamed_file",
"New Name": "a_renamed_file"
}
The move method move "old" file or directory to specified "new" directory. It is possible to specify absolute path from fileRoot dir or relative path from "old" item. "root" value is mandatory to secure that relative paths don't get above fileRoot.
Example Request: Move file
[path to connector]?mode=move&old=/uploads/images/original/Image/logo.png&new=/moved/&root=/uploads/images/
Example Response:
{
"Error": "No error",
"Code": 0,
"Old Path": "/uploads/images/original/Image/",
"Old Name": "logo.png",
"New Path": "/uploads/images/moved/",
"New Name": "logo.png"
}
Example Request: Move directory to not existing directory (will be created)
[path to connector]?mode=move&old=/uploads/images/original/Image&new=../new_dir/&root=/uploads/images/
Example Response:
{
"Error": "No error",
"Code": 0,
"Old Path": "/uploads/images/original/",
"Old Name": "Image",
"New Path": "/uploads/new_dir/",
"New Name": "Image"
}
The delete method deletes the item at the given path.
Example Request:
[path to connector]?mode=delete&path=/userfiles/images/logo.png
Example Response:
{
"Error": "No error",
"Code": 0,
"Path": "/userfiles/images/logo.png"
}
The replace method allow the user to replace a specific file whatever the new filename - at least, the new file should have the same extension the original has. The old file is automatically overwritten. Unlike the other methods, this method must return its JSON response wrapped in an HTML <textarea>, so the MIME type of the response is text/html instead of text/plain. The dynamic upload form in the File Manager passes the current file path as a POST param along with the uploaded file. The response includes the path as well as the name used to store the file.
Example Response:
{
"Path": "/userfiles/images/",
"Name": "new_logo.png",
"Error": "No error",
"Code": 0
}
The editfile method returns the content of a given file (passed as parameter). It gives the user the ability to edit a file online (extensions are specified in configuration file). Handled as GET request.
Example request:
[path to connector]?mode=editfile&path=/userfiles/MyFolder/myfile.txt
Example Response:
{
"Error": "No error",
"Code": 0,
"Path": "/userfiles/MyFolder/myfile.txt",
"Content": "Content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n\Phasellus eu erat lorem.\r\n\r\n\Bye!"
}
The save method will overwrite the content of the current file. The edit form in the File Manager passes the mode (as savefile), path of the current file and the content as POST parameters.
Example Response:
{
"Error": "No error",
"Code": 0,
"Path": "/userfiles/MyFolder/myfile.txt"
}
The getimage method serves the requested image for displaying. The image path is passed through the path parameter. If thumbnail=true parameter is passed, the method will return an image thumbnail. An extra parameter such as UNIX time can be added to the URL to prevent cache issue.
Example Request:
[path to connector]?mode=getimage&path=/userfiles/new%20logo.png&thumbnail=true
The download method serves the requested file to the user. We currently use a MIME type of "application/x-download" to force the file to be downloaded rather than displayed in a browser. In the future we may make exceptions for specific file types that often have in-browser viewers such as PDF's and various movie formats (Flash, Quicktime, etc.).
Example Request:
[path to connector]?mode=download&path=/userfiles/new%20logo.png
Released under the MIT license.
FAQs
Highly customizable open-source file manager
The npm package rich-filemanager receives a total of 39 weekly downloads. As such, rich-filemanager popularity was classified as not popular.
We found that rich-filemanager demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.