elFinderPluginNormalizer

Complexity

Total Complexity

34

Size/Duplication

Total Lines	119
Duplicated Lines	46.22 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
B	cmdPreprocess()	22	22	6
B	cmdPostprocess()	16	16	7
A	onUpLoadPreSave()	11	11	2
F	normalize()	6	43	18

<?php
/**
 * elFinder Plugin Normalizer.
 *
 * UTF-8 Normalizer of file-name and file-path etc.
 * nfc(NFC): Canonical Decomposition followed by Canonical Composition
 * nfkc(NFKC): Compatibility Decomposition followed by Canonical
 *
 * This plugin require Class "Normalizer" (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
 * or PEAR package "I18N_UnicodeNormalizer"
 *
 * ex. binding, configure on connector options
 *	$opts = array(
 *		'bind' => array(
 *			'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre ls.pre' => array(
 *				'Plugin.Normalizer.cmdPreprocess'
 *			),
 *			'ls' => array(
 *				'Plugin.Normalizer.cmdPostprocess'
 *			),
 *			'upload.presave' => array(
 *				'Plugin.Normalizer.onUpLoadPreSave'
 *			)
 *		),
 *		// global configure (optional)
 *		'plugin' => array(
 *			'Normalizer' => array(
 *				'enable'    => true,
 *				'nfc'       => true,
 *				'nfkc'      => true,
 *				'umlauts'   => false,
 *				'lowercase' => false,
 * 				'convmap'   => array()
 *			)
 *		),
 *		// each volume configure (optional)
 *		'roots' => array(
 *			array(
 *				'driver' => 'LocalFileSystem',
 *				'path'   => '/path/to/files/',
 *				'URL'    => 'http://localhost/to/files/'
 *				'plugin' => array(
 *					'Normalizer' => array(
 *						'enable'    => true,
 *						'nfc'       => true,
 *						'nfkc'      => true,
 *						'umlauts'   => false,
 * 						'lowercase' => false,
 * 						'convmap'   => array()
 *					)
 *				)
 *			)
 *		)
 *	);
 *
 * @author Naoki Sawada
 * @license New BSD
 */
class elFinderPluginNormalizer extends elFinderPlugin

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    private $replaced = [];
    private $keyMap = [
        'ls' => 'intersect',
        'upload' => 'renames',
    ];

    public function __construct($opts)
    {
        $defaults = [
            'enable' => true,  // For control by volume driver
            'nfc' => true,  // Canonical Decomposition followed by Canonical Composition
            'nfkc' => true,  // Compatibility Decomposition followed by Canonical
            'umlauts' => false, // Convert umlauts with their closest 7 bit ascii equivalent
            'lowercase' => false, // Make chars lowercase
            'convmap' => [], // Convert map ('FROM' => 'TO') array

43% of this comment could be valid code. Did you maybe forget this after debugging?

        ];

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

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

The parameter $elfinder is not used and could be removed.

This method seems to be duplicated in your project.

    {
        $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->normalize($name, $opts);
                }
            } else {
                $name = $args[$key];
                $this->replaced[$cmd][$name] = $args[$key] = $this->normalize($name, $opts);
            }
        }

        return true;
    }

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

The parameter $args is not used and could be removed.

The parameter $elfinder is not used and could be removed.

This method seems to be duplicated in your project.

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

    // NOTE: $thash is directory hash so it unneed to process at here
    public function onUpLoadPreSave(&$thash, &$name, $src, $elfinder, $volume)

The parameter $thash is not used and could be removed.

The parameter $src is not used and could be removed.

The parameter $elfinder is not used and could be removed.

This method seems to be duplicated in your project.

    {
        $opts = $this->getCurrentOpts($volume);
        if (! $opts['enable']) {
            return false;
        }

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

        return true;
    }

    private function normalize($str, $opts)
    {
        if ($opts['nfc'] || $opts['nfkc']) {
            if (class_exists('Normalizer', false)) {
                if ($opts['nfc'] && ! Normalizer::isNormalized($str, Normalizer::FORM_C)) {

This code seems to be duplicated across your project.

                    $str = Normalizer::normalize($str, Normalizer::FORM_C);
                }
                if ($opts['nfkc'] && ! Normalizer::isNormalized($str, Normalizer::FORM_KC)) {

This code seems to be duplicated across your project.

                    $str = Normalizer::normalize($str, Normalizer::FORM_KC);
                }
            } else {
                if (! class_exists('I18N_UnicodeNormalizer', false)) {
                    include_once 'I18N/UnicodeNormalizer.php';
                }
                if (class_exists('I18N_UnicodeNormalizer', false)) {
                    $normalizer = new I18N_UnicodeNormalizer();
                    if ($opts['nfc']) {
                        $str = $normalizer->normalize($str, 'NFC');
                    }
                    if ($opts['nfkc']) {
                        $str = $normalizer->normalize($str, 'NFKC');
                    }
                }
            }
        }
        if ($opts['umlauts']) {
            if (strpos($str = htmlentities($str, ENT_QUOTES, 'UTF-8'), '&') !== false) {
                $str = html_entity_decode(preg_replace('~&([a-z]{1,2})(?:acute|cedil|circ|grave|lig|orn|ring|slash|tilde|uml);~i', '$1', $str), ENT_QUOTES, 'utf-8');
            }
        }
        if ($opts['convmap'] && is_array($opts['convmap'])) {
            $str = strtr($str, $opts['convmap']);
        }
        if ($opts['lowercase']) {
            if (function_exists('mb_strtolower')) {
                $str = mb_strtolower($str, 'UTF-8');
            } else {
                $str = strtolower($str);
            }
        }

        return $str;
    }
}