<?php
/**
 * elFinder Plugin Sanitizer
 *
 * Sanitizer of file-name and file-path etc.
 *
 * ex. binding, configure on connector options
 *	$opts = array(
 *		'bind' => array(
 *			'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre ls.pre' => array(
 *				'Plugin.Sanitizer.cmdPreprocess'
 *			),
 *			'ls' => array(
 *				'Plugin.Sanitizer.cmdPostprocess'
 *			),
 *			'upload.presave' => array(
 *				'Plugin.Sanitizer.onUpLoadPreSave'
 *			)
 *		),
 *		// global configure (optional)
 *		'plugin' => array(
 *			'Sanitizer' => array(
 *				'enable' => true,
 *				'targets'  => array('\\','/',':','*','?','"','<','>','|'), // target chars
 *				'replace'  => '_'    // replace to this
 *			)
 *		),
 *		// each volume configure (optional)
 *		'roots' => array(
 *			array(
 *				'driver' => 'LocalFileSystem',
 *				'path'   => '/path/to/files/',
 *				'URL'    => 'http://localhost/to/files/'
 *				'plugin' => array(
 *					'Sanitizer' => array(
 *						'enable' => true,
 *						'targets'  => array('\\','/',':','*','?','"','<','>','|'), // target chars
 *						'replace'  => '_'    // replace to this
 *					)
 *				)
 *			)
 *		)
 *	);
 *
 * @package elfinder
 * @author Naoki Sawada
 * @license New BSD
 */
class elFinderPluginSanitizer extends elFinderPlugin
{
    private $replaced = [];
    private $keyMap = [
        'ls' => 'intersect',
        'upload' => 'renames',
    ];

    public function __construct($opts)
    {
        $defaults = [
            'enable' => true,  // For control by volume driver
            'targets' => ['\\', '/', ':', '*', '?', '"', '<', '>', '|'], // target chars
            'replace' => '_',    // replace to this
        ];

        $this->opts = array_merge($defaults, $opts);
    }

    public function cmdPreprocess($cmd, &$args, $elfinder, $volume)
    {
        $opts = $this->getCurrentOpts($volume);
        if (!$opts['enable']) {
            return false;
        }
        $this->replaced[$cmd] = [];
        $key = (isset($this->keyMap[$cmd])) ? $this->keyMap[$cmd] : 'name';

        if (isset($args[$key])) {
            if (is_array($args[$key])) {
                foreach ($args[$key] as $i => $name) {
                    $this->replaced[$cmd][$name] = $args[$key][$i] = $this->sanitizeFileName($name, $opts);
                }
            } else {
                $name = $args[$key];
                $this->replaced[$cmd][$name] = $args[$key] = $this->sanitizeFileName($name, $opts);
            }
        }

        return true;
    }

    public function cmdPostprocess($cmd, &$result, $args, $elfinder)
    {
        if ('ls' === $cmd) {
            if (!empty($result['list']) && !empty($this->replaced['ls'])) {
                foreach ($result['list'] as $hash => $name) {
                    if ($keys = array_keys($this->replaced['ls'], $name, true)) {
                        if (1 === count($keys)) {
                            $result['list'][$hash] = $keys[0];
                        } else {
                            $result['list'][$hash] = $keys;
                        }
                    }
                }
            }
        }
    }

    public function onUpLoadPreSave(&$path, &$name, $src, $elfinder, $volume)
    {
        $opts = $this->getCurrentOpts($volume);
        if (!$opts['enable']) {
            return false;
        }

        if ($path) {
            $path = $this->sanitizeFileName($path, $opts, ['/']);
        }
        $name = $this->sanitizeFileName($name, $opts);

        return true;
    }

    private function sanitizeFileName($filename, $opts, $allows = [])
    {
        $targets = $allows ? array_diff($opts['targets'], $allows) : $opts['targets'];

        return str_replace($targets, $opts['replace'], $filename);
    }
}
