<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* elFinder Plugin Normalizer

[3] Fix | Delete

* UTF-8 Normalizer of file-name and file-path etc.

[4] Fix | Delete

* nfc(NFC): Canonical Decomposition followed by Canonical Composition

[5] Fix | Delete

* nfkc(NFKC): Compatibility Decomposition followed by Canonical

[6] Fix | Delete

* This plugin require Class "Normalizer" (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)

[7] Fix | Delete

* or PEAR package "I18N_UnicodeNormalizer"

[8] Fix | Delete

* ex. binding, configure on connector options

[9] Fix | Delete

* $opts = array(

[10] Fix | Delete

* 'bind' => array(

[11] Fix | Delete

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

[12] Fix | Delete

* 'Plugin.Normalizer.cmdPreprocess'

[13] Fix | Delete

* ),

[14] Fix | Delete

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

[15] Fix | Delete

* 'Plugin.Normalizer.onUpLoadPreSave'

[16] Fix | Delete

* )

[17] Fix | Delete

* ),

[18] Fix | Delete

* // global configure (optional)

[19] Fix | Delete

* 'plugin' => array(

[20] Fix | Delete

* 'Normalizer' => array(

[21] Fix | Delete

* 'enable' => true,

[22] Fix | Delete

* 'nfc' => true,

[23] Fix | Delete

* 'nfkc' => true,

[24] Fix | Delete

* 'umlauts' => false,

[25] Fix | Delete

* 'lowercase' => false,

[26] Fix | Delete

* 'convmap' => array()

[27] Fix | Delete

* )

[28] Fix | Delete

* ),

[29] Fix | Delete

* // each volume configure (optional)

[30] Fix | Delete

* 'roots' => array(

[31] Fix | Delete

* array(

[32] Fix | Delete

* 'driver' => 'LocalFileSystem',

[33] Fix | Delete

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

[34] Fix | Delete

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

[35] Fix | Delete

* 'plugin' => array(

[36] Fix | Delete

* 'Normalizer' => array(

[37] Fix | Delete

* 'enable' => true,

[38] Fix | Delete

* 'nfc' => true,

[39] Fix | Delete

* 'nfkc' => true,

[40] Fix | Delete

* 'umlauts' => false,

[41] Fix | Delete

* 'lowercase' => false,

[42] Fix | Delete

* 'convmap' => array()

[43] Fix | Delete

* )

[44] Fix | Delete

* )

[45] Fix | Delete

* )

[46] Fix | Delete

* )

[47] Fix | Delete

* );

[48] Fix | Delete

*

[49] Fix | Delete

* @package elfinder

[50] Fix | Delete

* @author Naoki Sawada

[51] Fix | Delete

* @license New BSD

[52] Fix | Delete

*/

[53] Fix | Delete

class elFinderPluginNormalizer extends elFinderPlugin

[54] Fix | Delete

{

[55] Fix | Delete

private $replaced = array();

[56] Fix | Delete

private $keyMap = array(

[57] Fix | Delete

'ls' => 'intersect',

[58] Fix | Delete

'upload' => 'renames',

[59] Fix | Delete

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

[60] Fix | Delete

);

[61] Fix | Delete

[62] Fix | Delete

public function __construct($opts)

[63] Fix | Delete

{

[64] Fix | Delete

$defaults = array(

[65] Fix | Delete

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

[66] Fix | Delete

'nfc' => true, // Canonical Decomposition followed by Canonical Composition

[67] Fix | Delete

'nfkc' => true, // Compatibility Decomposition followed by Canonical

[68] Fix | Delete

'umlauts' => false, // Convert umlauts with their closest 7 bit ascii equivalent

[69] Fix | Delete

'lowercase' => false, // Make chars lowercase

[70] Fix | Delete

'convmap' => array()// Convert map ('FROM' => 'TO') array

[71] Fix | Delete

);

[72] Fix | Delete

[73] Fix | Delete

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

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

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

[77] Fix | Delete

{

[78] Fix | Delete

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

[79] Fix | Delete

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

[80] Fix | Delete

return false;

[81] Fix | Delete

}

[82] Fix | Delete

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

[83] Fix | Delete

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

[84] Fix | Delete

[85] Fix | Delete

if (is_array($key)) {

[86] Fix | Delete

$keys = $key;

[87] Fix | Delete

} else {

[88] Fix | Delete

$keys = array($key);

[89] Fix | Delete

}

[90] Fix | Delete

foreach ($keys as $key) {

[91] Fix | Delete

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

[92] Fix | Delete

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

[93] Fix | Delete

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

[94] Fix | Delete

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

[95] Fix | Delete

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

[96] Fix | Delete

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

[97] Fix | Delete

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

[98] Fix | Delete

$_res = array();

[99] Fix | Delete

foreach ($_names as $_name) {

[100] Fix | Delete

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

[101] Fix | Delete

}

[102] Fix | Delete

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

[103] Fix | Delete

} else {

[104] Fix | Delete

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

[105] Fix | Delete

}

[106] Fix | Delete

}

[107] Fix | Delete

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

[108] Fix | Delete

$name = $args[$key];

[109] Fix | Delete

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

[110] Fix | Delete

}

[111] Fix | Delete

}

[112] Fix | Delete

}

[113] Fix | Delete

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

[114] Fix | Delete

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

[115] Fix | Delete

// un-regist for legacy settings

[116] Fix | Delete

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

[117] Fix | Delete

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

[118] Fix | Delete

}

[119] Fix | Delete

}

[120] Fix | Delete

return true;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

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

[124] Fix | Delete

{

[125] Fix | Delete

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

[126] Fix | Delete

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

[127] Fix | Delete

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

[128] Fix | Delete

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

[129] Fix | Delete

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

[130] Fix | Delete

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

[131] Fix | Delete

} else {

[132] Fix | Delete

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

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

}

[137] Fix | Delete

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

[138] Fix | Delete

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

[139] Fix | Delete

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

[140] Fix | Delete

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

[141] Fix | Delete

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

[142] Fix | Delete

}

[143] Fix | Delete

}

[144] Fix | Delete

}

[145] Fix | Delete

}

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

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

[149] Fix | Delete

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

[150] Fix | Delete

{

[151] Fix | Delete

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

[152] Fix | Delete

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

[153] Fix | Delete

return false;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

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

[157] Fix | Delete

return true;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

protected function normalize($str, $opts)

[161] Fix | Delete

{

[162] Fix | Delete

if ($opts['nfc'] || $opts['nfkc']) {

[163] Fix | Delete

if (class_exists('Normalizer', false)) {

[164] Fix | Delete

if ($opts['nfc'] && !Normalizer::isNormalized($str, Normalizer::FORM_C))

[165] Fix | Delete

$str = Normalizer::normalize($str, Normalizer::FORM_C);

[166] Fix | Delete

if ($opts['nfkc'] && !Normalizer::isNormalized($str, Normalizer::FORM_KC))

[167] Fix | Delete

$str = Normalizer::normalize($str, Normalizer::FORM_KC);

[168] Fix | Delete

} else {

[169] Fix | Delete

if (!class_exists('I18N_UnicodeNormalizer', false)) {

[170] Fix | Delete

if (is_readable('I18N/UnicodeNormalizer.php')) {

[171] Fix | Delete

include_once 'I18N/UnicodeNormalizer.php';

[172] Fix | Delete

} else {

[173] Fix | Delete

trigger_error('Plugin Normalizer\'s options "nfc" or "nfkc" require PHP class "Normalizer" or PEAR package "I18N_UnicodeNormalizer"', E_USER_WARNING);

[174] Fix | Delete

}

[175] Fix | Delete

}

[176] Fix | Delete

if (class_exists('I18N_UnicodeNormalizer', false)) {

[177] Fix | Delete

$normalizer = new I18N_UnicodeNormalizer();

[178] Fix | Delete

if ($opts['nfc'])

[179] Fix | Delete

$str = $normalizer->normalize($str, 'NFC');

[180] Fix | Delete

if ($opts['nfkc'])

[181] Fix | Delete

$str = $normalizer->normalize($str, 'NFKC');

[182] Fix | Delete

}

[183] Fix | Delete

}

[184] Fix | Delete

}

[185] Fix | Delete

if ($opts['umlauts']) {

[186] Fix | Delete

if (strpos($str = htmlentities($str, ENT_QUOTES, 'UTF-8'), '&') !== false) {

[187] Fix | Delete

$str = html_entity_decode(preg_replace('~&([a-z]{1,2})(?:acute|caron|cedil|circ|grave|lig|orn|ring|slash|tilde|uml);~i', '$1', $str), ENT_QUOTES, 'utf-8');

[188] Fix | Delete

}

[189] Fix | Delete

}

[190] Fix | Delete

if ($opts['convmap'] && is_array($opts['convmap'])) {

[191] Fix | Delete

$str = strtr($str, $opts['convmap']);

[192] Fix | Delete

}

[193] Fix | Delete

if ($opts['lowercase']) {

[194] Fix | Delete

if (function_exists('mb_strtolower')) {

[195] Fix | Delete

$str = mb_strtolower($str, 'UTF-8');

[196] Fix | Delete

} else {

[197] Fix | Delete

$str = strtolower($str);

[198] Fix | Delete

}

[199] Fix | Delete

}

[200] Fix | Delete

return $str;

[201] Fix | Delete

}

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete