Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* elFinder Plugin Sanitizer

[3] Fix | Delete

* Sanitizer of file-name and file-path etc.

[4] Fix | Delete

* ex. binding, configure on connector options

[5] Fix | Delete

* $opts = array(

[6] Fix | Delete

* 'bind' => array(

[7] Fix | Delete

* 'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre ls.pre' => array(

[8] Fix | Delete

* 'Plugin.Sanitizer.cmdPreprocess'

[9] Fix | Delete

* ),

[10] Fix | Delete

* 'upload.presave paste.copyfrom' => array(

[11] Fix | Delete

* 'Plugin.Sanitizer.onUpLoadPreSave'

[12] Fix | Delete

* )

[13] Fix | Delete

* ),

[14] Fix | Delete

* // global configure (optional)

[15] Fix | Delete

* 'plugin' => array(

[16] Fix | Delete

* 'Sanitizer' => array(

[17] Fix | Delete

* 'enable' => true,

[18] Fix | Delete

* 'targets' => array('\\','/',':','*','?','"','<','>','|'), // target chars

[19] Fix | Delete

* 'replace' => '_', // replace to this

[20] Fix | Delete

* 'callBack' => null // Or @callable sanitize function

[21] Fix | Delete

* )

[22] Fix | Delete

* ),

[23] Fix | Delete

* // each volume configure (optional)

[24] Fix | Delete

* 'roots' => array(

[25] Fix | Delete

* array(

[26] Fix | Delete

* 'driver' => 'LocalFileSystem',

[27] Fix | Delete

* 'path' => '/path/to/files/',

[28] Fix | Delete

* 'URL' => 'http://localhost/to/files/'

[29] Fix | Delete

* 'plugin' => array(

[30] Fix | Delete

* 'Sanitizer' => array(

[31] Fix | Delete

* 'enable' => true,

[32] Fix | Delete

* 'targets' => array('\\','/',':','*','?','"','<','>','|'), // target chars

[33] Fix | Delete

* 'replace' => '_', // replace to this

[34] Fix | Delete

* 'callBack' => null // Or @callable sanitize function

[35] Fix | Delete

* )

[36] Fix | Delete

* )

[37] Fix | Delete

* )

[38] Fix | Delete

* )

[39] Fix | Delete

* );

[40] Fix | Delete

[41] Fix | Delete

* @package elfinder

[42] Fix | Delete

* @author Naoki Sawada

[43] Fix | Delete

* @license New BSD

[44] Fix | Delete

[45] Fix | Delete

class elFinderPluginSanitizer extends elFinderPlugin

[46] Fix | Delete

{

[47] Fix | Delete

private $replaced = array();

[48] Fix | Delete

private $keyMap = array(

[49] Fix | Delete

'ls' => 'intersect',

[50] Fix | Delete

'upload' => 'renames',

[51] Fix | Delete

'mkdir' => array('name', 'dirs')

[52] Fix | Delete

);

[53] Fix | Delete

[54] Fix | Delete

public function __construct($opts)

[55] Fix | Delete

{

[56] Fix | Delete

$defaults = array(

[57] Fix | Delete

'enable' => true, // For control by volume driver

[58] Fix | Delete

'targets' => array('\\', '/', ':', '*', '?', '"', '<', '>', '|'), // target chars

[59] Fix | Delete

'replace' => '_', // replace to this

[60] Fix | Delete

'callBack' => null // Or callable sanitize function

[61] Fix | Delete

);

[62] Fix | Delete

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

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

public function cmdPreprocess($cmd, &$args, $elfinder, $volume)

[66] Fix | Delete

{

[67] Fix | Delete

$opts = $this->getCurrentOpts($volume);

[68] Fix | Delete

if (!$opts['enable']) {

[69] Fix | Delete

return false;

[70] Fix | Delete

}

[71] Fix | Delete

$this->replaced[$cmd] = array();

[72] Fix | Delete

$key = (isset($this->keyMap[$cmd])) ? $this->keyMap[$cmd] : 'name';

[73] Fix | Delete

[74] Fix | Delete

if (is_array($key)) {

[75] Fix | Delete

$keys = $key;

[76] Fix | Delete

} else {

[77] Fix | Delete

$keys = array($key);

[78] Fix | Delete

}

[79] Fix | Delete

foreach ($keys as $key) {

[80] Fix | Delete

if (isset($args[$key])) {

[81] Fix | Delete

if (is_array($args[$key])) {

[82] Fix | Delete

foreach ($args[$key] as $i => $name) {

[83] Fix | Delete

if ($cmd === 'mkdir' && $key === 'dirs') {

[84] Fix | Delete

// $name need '/' as prefix see #2607

[85] Fix | Delete

$name = '/' . ltrim($name, '/');

[86] Fix | Delete

$_names = explode('/', $name);

[87] Fix | Delete

$_res = array();

[88] Fix | Delete

foreach ($_names as $_name) {

[89] Fix | Delete

$_res[] = $this->sanitizeFileName($_name, $opts);

[90] Fix | Delete

}

[91] Fix | Delete

$this->replaced[$cmd][$name] = $args[$key][$i] = join('/', $_res);

[92] Fix | Delete

} else {

[93] Fix | Delete

$this->replaced[$cmd][$name] = $args[$key][$i] = $this->sanitizeFileName($name, $opts);

[94] Fix | Delete

}

[95] Fix | Delete

}

[96] Fix | Delete

} else if ($args[$key] !== '') {

[97] Fix | Delete

$name = $args[$key];

[98] Fix | Delete

$this->replaced[$cmd][$name] = $args[$key] = $this->sanitizeFileName($name, $opts);

[99] Fix | Delete

}

[100] Fix | Delete

}

[101] Fix | Delete

}

[102] Fix | Delete

if ($cmd === 'ls' || $cmd === 'mkdir') {

[103] Fix | Delete

if (!empty($this->replaced[$cmd])) {

[104] Fix | Delete

// un-regist for legacy settings

[105] Fix | Delete

$elfinder->unbind($cmd, array($this, 'cmdPostprocess'));

[106] Fix | Delete

$elfinder->bind($cmd, array($this, 'cmdPostprocess'));

[107] Fix | Delete

}

[108] Fix | Delete

}

[109] Fix | Delete

return true;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

public function cmdPostprocess($cmd, &$result, $args, $elfinder, $volume)

[113] Fix | Delete

{

[114] Fix | Delete

if ($cmd === 'ls') {

[115] Fix | Delete

if (!empty($result['list']) && !empty($this->replaced['ls'])) {

[116] Fix | Delete

foreach ($result['list'] as $hash => $name) {

[117] Fix | Delete

if ($keys = array_keys($this->replaced['ls'], $name)) {

[118] Fix | Delete

if (count($keys) === 1) {

[119] Fix | Delete

$result['list'][$hash] = $keys[0];

[120] Fix | Delete

} else {

[121] Fix | Delete

$result['list'][$hash] = $keys;

[122] Fix | Delete

}

[123] Fix | Delete

}

[124] Fix | Delete

}

[125] Fix | Delete

}

[126] Fix | Delete

} else if ($cmd === 'mkdir') {

[127] Fix | Delete

if (!empty($result['hashes']) && !empty($this->replaced['mkdir'])) {

[128] Fix | Delete

foreach ($result['hashes'] as $name => $hash) {

[129] Fix | Delete

if ($keys = array_keys($this->replaced['mkdir'], $name)) {

[130] Fix | Delete

$result['hashes'][$keys[0]] = $hash;

[131] Fix | Delete

}

[132] Fix | Delete

}

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

// NOTE: $thash is directory hash so it unneed to process at here

[138] Fix | Delete

public function onUpLoadPreSave(&$thash, &$name, $src, $elfinder, $volume)

[139] Fix | Delete

{

[140] Fix | Delete

$opts = $this->getCurrentOpts($volume);

[141] Fix | Delete

if (!$opts['enable']) {

[142] Fix | Delete

return false;

[143] Fix | Delete

}

[144] Fix | Delete

$name = $this->sanitizeFileName($name, $opts);

[145] Fix | Delete

return true;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

protected function sanitizeFileName($filename, $opts)

[149] Fix | Delete

{

[150] Fix | Delete

if (!empty($opts['callBack']) && is_callable($opts['callBack'])) {

[151] Fix | Delete

return call_user_func_array($opts['callBack'], array($filename, $opts));

[152] Fix | Delete

}

[153] Fix | Delete

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

[154] Fix | Delete

}

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete