KodExplorer Documentation

KodExplorer is currently in maintenance mode and no longer receives new features. It is highly recommended to use Kodbox, the new design upgrade product, for active development and new features.

• Kodbox Repository: https://github.com/kalcaddle/kodbox
• Kodbox Download: https://kodcloud.com/download/

To install KodExplorer by downloading the master zip archive, use wget to fetch the file, unzip it, and set the directory permissions.

wget https://github.com/kalcaddle/KODExplorer/archive/master.zip
unzip master.zip
chmod -Rf 777 ./*

Before installing, ensure your environment meets the following requirements:

Server Requirements

• Operating Systems: Windows, Linux, Mac, or even routers/home NAS.
• PHP: Version 5.0 or higher.
• Database: Supports File system driver, SQLite, MySQL, and others.

Browser Compatibility

• Chrome
• Firefox
• Opera
• IE8+

To install KodExplorer using Git, clone the repository and ensure the directory has the necessary write permissions.

git clone https://github.com/kalcaddle/KODExplorer.git
chmod -Rf 777 ./KODExplorer/*

To improve the security of your KodExplorer instance, follow these best practices:

1. Password Complexity: Ensure the administrator password is complex.
2. Verification Code: Enable the login verification code.
3. Directory Listing: Configure your HTTP server to disallow directory listing.
4. PHP Security: Set the open_basedir path in your PHP configuration to restrict file access.

The kodApp.open() method is the primary way to programmatically trigger the opening of a file or folder using its registered application handler.

Signature: kodApp.open(path, ext, appName)

• path: The file or folder path.
• ext: The file extension (optional).
• appName: The name of the application to use (optional).

To embed a code editor in a form, use initCodeEditor. This function asynchronously loads the Ace editor library, enables language tools, and sets up Emmet support.

Requirements:

• A textarea element with the class .form-codeEditor.
• Optional data attributes on the parent: data-theme (default: tomorrow), data-mode (default: javascript), data-font-size (default: 14).

Features enabled by default:

• Emmet support
• Snippets
• Basic Autocompletion
• Live Autocompletion
• Custom command: Ctrl-alt-G (or Ctrl-command-G on Mac) to preview.

The kodApp module provides a central registry for managing file associations and application behaviors within the explorer. Developers can register new applications, manage which applications handle specific file extensions, and set default handlers for users.

Key capabilities:

• Registering apps: Use add() to register a new application with a name, title, icon, and callback function.
• File associations: Use addSupportSet() to associate an application with specific file extensions.
• Retrieving apps: Use getApp() to find an application by its extension or getAppMenu() to retrieve the menu configuration for a specific file type.
• User defaults: Use setOpenUser() to set a specific application as the default for a user, or setOpenUserLocal() for local-only settings.

The getFormData function iterates through all .form-row elements within the current $wrap context to collect values based on their data-type. It handles various input types including:

• input, textarea, password, number, slider, color, dateTime, segment, citypicker, fileSelect (returns .val())
• codeEditor (returns value from Ace editor instance)
• switch (returns 0 or 1)
• radio (returns checked value)
• checkbox (returns comma-separated values)
• select, selectMutil, tags, group, role, user (returns .val(), joining arrays with commas)
• userSelect (returns a formatted string: all:all_val;user:user_val;group:group_val;role:role_val)

If a field is marked as require in itemsConfig and is empty, getFormData will mark the row with an .error class and return checked: 0.

bindFileSelect enables a file/image picker for elements with the .path-select class. It uses core.api.pathSelect to open a selection interface.

Configuration: Pass configuration via a data-info attribute on the input, which should be a JSON string. Supported keys include:

• type: (default file)
• title: (default LNG.path_api_select_image)
• allowExt: Pipe-separated extensions (e.g., png|jpg|bmp)
• result: The format of the returned value (e.g., url or path)

Example:

<div class="path-select">
  <input type="text" data-info='{"allowExt":"png|jpg", "result":"url"}'>
  <button class="btn">Select</button>
</div>

Use kodApp.appSupportSet() to associate an application with multiple file extensions and define their sort order.

Parameters:

• appName: The name of the application.
• extensions: An array or comma-separated string of extensions.
• sort: (Optional) Integer defining the priority of the association.

The DPlayerPlugin class extends PluginBase to provide video playback capabilities using DPlayer. It registers a hook on user.commonJs.insert to inject the plugin's JavaScript assets into the user interface. When the hook is triggered, the plugin checks for file extension compatibility via isFileExtence and then serves the client-side logic located at static/main.js using echoFile.

<?php

class DPlayerPlugin extends PluginBase{
	function __construct(){
		parent::__construct();
	}
	public function regiest(){
		$this->hookRegiest(array(
			'user.commonJs.insert' => 'DPlayerPlugin.echoJs',
		));
	}
	public function echoJs($st,$act){
		if($this->isFileExtence($st,$act)){
			$this->echoFile('static/main.js');
		}
	}
}