Plugins



Introduction

AjaXplorer comes fully loaded with various plugins to ease the integration with other systems, help you develop your own specific installation, or even use AjaXplorer as a very generic explorer-like GUI, for browsing any type of data.

Plugins can be seen as « features ». They come packed with their own actions and parameters, and can drastically change the way AjaXplorer works.  A plugin is composed of a folder « plugintype.pluginname » containing at least an XML file describing the plugin, the manifest.xml. When you want to customize, duplicate, understand a plugin, a good start is always to look at the manifest.xml. A plugin can come with various resources : PHP code, Javascript, images, internationalisation data, etc. All these are always declared in the manifest.xml.

How to install?

Most plugin come directly from the core, and you don’t have anything to do to « install » them. If you have downloaded a plugin, then drop it inside the plugins folder of the application, and clear your cache (see below). There are a couple of plugins that must be activated via configuration files because they are necessary for the starting of the application : see the file conf/bootstrap_plugins.php.  For all the other plugins, you have to check and activate them via the GUI, in the Settings section (accessible as administrator only).

Clearing the cache

Warning, since the gathering of all manifest.xml files into one huge XML registry is CPU intensive, there is a cache mechanism to avoid parsing these file at each request. This implies that when you make changes to a plugin, you’ll have to delete the two new cache files located in the data/cache folder : plugins_cache.ser and plugins_requires.ser. If you’re developing, you’ll want to disable this cache totally. This possible by setting the AJXP_SKIP_CACHE to « true » inside conf/bootstrap_context.php.

Since version 4, another way to automatically clear the cache is simply editing one of the plugins configuration accessible in the GUI via Settings > Plugins Options (for example disable/re-enable a plugin).

Plugins list

In this section, all the plugins available to extend AjaXplorer features are listed. Each plugin has its own forum thread embedded in the page, please use it to add any comment that could be helpfull for other users.

Core | Contributed
Core plugins
Access plugins
  • Admin Driver : Access AjaXplorer configuration data..
  • File System (Standard) : The most standard access to a filesystem located on the server..
  • Remote Server (via API) : Access a remote server implementing the AjaXplorer API (most commonly a remote server with another AjaXplorer installed).
  • FTP Server : This driver can access a remote FTP server.
  • Demo (no write actions) : This is a standard access to the filesystem but with all write actions disabled server-side..
  • FTP over SSH : Access a remote server filesystem using FTP via SSH server. Handy for working around permissions problems..
  • Mailbox (Imap or POP) : This plugin will browse the content of a mailbox (imap or pop) and allow to grab emails attachments and copy them to another repository. Requires the PHP IMAP extension..
  • Samba : Browse a Samba Server.
  • WMS Server : Browse the layers served by a WMS server..
  • S3 (Amazon Web Service) : Access an AWS server. Requires AWS-SDK for PHP.
  • Javascript Api Browser : Browse AjaXplorer Javascript classes and interfaces. Helper for developpers, but also good demonstration of how Ajaxplorer data can be fed by something different than a remote server filesystem!.
  • WebDAV (PEAR) : Access a WebDAV server. Requires PEAR/HTTP_WebDAVClient installed with the patched found in the plugin folder applied..
  • Mysql Database : This driver can browse and update tables and records in a MySQL database, kind of phpMyAdmin..
  • Shared Elements : Browse user shared elements..
  • Dropbox : This plugin allows accessing a dropbox account. Still experimental, requires PEAR/HTTP_OAuth extension..
Action plugins
  • Tasks Scheduler : Register tasks to be run on a regular basis instead of writing them one by one in cron tab..
  • Skeleton Plugin : This is an empty container to demonstrate the basics of plugins coding..
  • Sharing Features : Share Center actions and hooks.
  • Power FS : This set of extensions assume that you have an administration access to your server: ability to tweak the webserver and the php configuration, ability to access the command line, etc..
  • Update Engine : Automatic update of AjaXplorer. Since version 3.3.3.
Auth plugins
Conf plugins
Downloader plugins
Editor plugins
  • Image viewer : Image viewer, used for previewing images and browsing them in a diaporam. Generates a thumbnail version of the images..
  • Sound Player : Inserts a flash player for reading mp3 files online, and playing a whole folder in a separate window..
  • EXIF Extractor : Display the Exif metadata contained inside the JPG files. Can locate the image on a map if it contains geolocation data..
  • Source Viewer : Syntax Highlighter for all major code source files.
  • Text Editor : Very basic text editor.
  • Open in… : Simple Picker to open any type of file in any available editor..
  • Email Viewer : Email reader, supports eml format and eml mimetypes. Detects if a folder contains only email and display columns accordingly..
  • Pixlr Editor : Bridge to the Pixlr.com webservice that allow online image edition via a photoshop-like GUI..
  • Image Magick : Image Magick viewer supports PDF and various images formats preview. Requires external library to be installed on the server..
  • External Window : Open file in a new browser window, thus using native browser capabilities..
  • Sound Player : Uses HTML5 or Flash to play a sound.
  • CKEditor : Wysiwyg HTML Editor, requires separate library to be downloaded..
  • Office Docs : Zoho editor.
  • Video Player : Inserts a video player in the info panel, either HTML5 or Flash depending on the format..
  • CodePress : Legacy Syntax Highlighter.
  • Map viewer : Geolocation feature to either display a WMS layer or simply place an exif-localized photo. Requires OpenLayers.
Gui plugins
  • Client Plugin : Browser-based rich interface. Contains configurations for theming, custom welcome message, etc..
  • Light : Simple Template for Bookmarklets.
  • Mobile : Template extending gui.ajax for small screen terminals..
  • iOS : Template for redirecting to iPhone application.
Index plugins
  • Lucene Search Engine : Zend_Search_Lucene implementation to index all files and search a whole repository quickly..
Log plugins
Meta plugins
  • Exif Metadata : Extracts the EXIF metadata of a JPG image. Used in conjunction with editor.exif.
  • File Hasher : Compute on-demand a hash of the file content and stores it in the metadata if a metastore is provided.
  • Subversion Repository : Extract SVN informations (revision, change log, etc) if the repository is a Working-Copy, and SVN is available as a commandline..
  • FS Mount : Mount a remote location on the file system before accessing the repository.
  • User quota : Maintain the size of a given directory for each user.
  • Git-based Versioning : Keep tracks of all files modifications using a local Git repository.
  • Text Metadata : Simple metadata implementation stored in a hidden file..
  • Simple Lock : Manual Locking mechanism to avoid concurrent edition.
Metastore plugins
Notify plugins
Shorten plugins
  • Bit.ly URL Shortener : Shorten Download Links before sending them back to the user. Requires a Bit.ly account..
Uploader plugins
  • Jumploader : Third-party JumpLoader JAVA applet allowing to upload folders, chunk big files, etc..
  • Flash uploader : Legacy flash uploader, used when the browser does not support HTML5. If you want to force the usage of this uploader, deactivate the uploader.html, and remove the activeCondition tag from the uploader.flex manifest file..
  • HTML Uploader : Auto-switching HTML5 or IFrame uploader..


Fork me on GitHub