elFinderConnector - Code Metrics - recca0120/laravel-elfinder - Measure and Improve Code Quality continuously with Scrutinizer

elFinderConnector C
last analyzed 2018-02-09 05:57 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	327
Duplicated Lines	2.14 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	7
loc	327
rs	5.488
c	0
b	0
f	0
wmc	76
lcom	1
cbo	2

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
F	run()	0	91	33
C	outputJson()	0	27	8
F	output()	7	92	24
B	input_filter()	0	16	5
A	sendHeader()	0	12	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like elFinderConnector often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use elFinderConnector, and based on these observations, apply Extract Interface, too.

<?php

/**
 * Default elFinder connector.
 *
 * @author Dmitry (dio) Levashov
 **/
class elFinderConnector
namespace YourVendor;

class YourClass { }
{
    /**
     * elFinder instance.
     *
     * @var elFinder
     **/
    protected $elFinder;

    /**
     * Options.
     *
     * @var aray
     **/
    protected $options = [];

    /**
     * Must be use output($data) $data['header'].
     *
     * @var string
     * @deprecated
     **/
    protected $header = '';

    /**
     * HTTP request method.
     *
     * @var string
     */
    protected $reqMethod = '';

    /**
     * Content type of output JSON.
     *
     * @var string
     */
    protected static $contentType = 'Content-Type: application/json';

    /**
     * Constructor.
     *
     * @param $elFinder
     * @param bool $debug
     * @author Dmitry (dio) Levashov
     */
    public function __construct($elFinder, $debug = false)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $this->elFinder = $elFinder;
        $this->reqMethod = strtoupper($_SERVER['REQUEST_METHOD']);
        if ($debug) {
            self::$contentType = 'Content-Type: text/plain; charset=utf-8';
        }
    }

    /**
     * Execute elFinder command and output result.
     *
     * @return void
     * @author Dmitry (dio) Levashov
     **/
    public function run()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $isPost = $this->reqMethod === 'POST';
        $src = $isPost ? $_POST : $_GET;
        $maxInputVars = (! $src || isset($src['targets'])) ? ini_get('max_input_vars') : null;
        if ((! $src || $maxInputVars) && $rawPostData = file_get_contents('php://input')) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            // for max_input_vars and supports IE XDomainRequest()
            $parts = explode('&', $rawPostData);
            if (! $src || $maxInputVars < count($parts)) {
                $src = [];
                foreach ($parts as $part) {
                    list($key, $value) = array_pad(explode('=', $part), 2, '');
                    $key = rawurldecode($key);
                    if (preg_match('/^(.+?)\[([^\[\]]*)\]$/', $key, $m)) {
                        $key = $m[1];
                        $idx = $m[2];
                        if (! isset($src[$key])) {
                            $src[$key] = [];
                        }
                        if ($idx) {
                            $src[$key][$idx] = rawurldecode($value);
                        } else {
                            $src[$key][] = rawurldecode($value);
                        }
                    } else {
                        $src[$key] = rawurldecode($value);
                    }
                }
                $_POST = $this->input_filter($src);
                $_REQUEST = $this->input_filter(array_merge_recursive($src, $_REQUEST));
            }
        }

        if (isset($src['targets']) && $this->elFinder->maxTargets && count($src['targets']) > $this->elFinder->maxTargets) {
            $error = $this->elFinder->error(elFinder::ERROR_MAX_TARGTES);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $this->output(['error' => $this->elFinder->error(elFinder::ERROR_MAX_TARGTES)]);
        }

        $cmd = isset($src['cmd']) ? $src['cmd'] : '';
        $args = [];

        if (! function_exists('json_encode')) {
            $error = $this->elFinder->error(elFinder::ERROR_CONF, elFinder::ERROR_CONF_NO_JSON);
            $this->output(['error' => '{"error":["'.implode('","', $error).'"]}', 'raw' => true]);
        }

        if (! $this->elFinder->loaded()) {
            $this->output(['error' => $this->elFinder->error(elFinder::ERROR_CONF, elFinder::ERROR_CONF_NO_VOL), 'debug' => $this->elFinder->mountErrors]);
        }

        // telepat_mode: on
        if (! $cmd && $isPost) {
            $this->output(['error' => $this->elFinder->error(elFinder::ERROR_UPLOAD, elFinder::ERROR_UPLOAD_TOTAL_SIZE), 'header' => 'Content-Type: text/html']);
        }
        // telepat_mode: off

        if (! $this->elFinder->commandExists($cmd)) {
            $this->output(['error' => $this->elFinder->error(elFinder::ERROR_UNKNOWN_CMD)]);
        }

        // collect required arguments to exec command
        $hasFiles = false;
        foreach ($this->elFinder->commandArgsList($cmd) as $name => $req) {
            if ($name === 'FILES') {
                if (isset($_FILES)) {
                    $hasFiles = true;
                } elseif ($req) {
                    $this->output(['error' => $this->elFinder->error(elFinder::ERROR_INV_PARAMS, $cmd)]);
                }
            } else {
                $arg = isset($src[$name]) ? $src[$name] : '';

                if (! is_array($arg) && $req !== '') {
                    $arg = trim($arg);
                }
                if ($req && $arg === '') {
                    $this->output(['error' => $this->elFinder->error(elFinder::ERROR_INV_PARAMS, $cmd)]);
                }
                $args[$name] = $arg;
            }
        }

        $args['debug'] = isset($src['debug']) ? (bool) $src['debug'] : false;

        $args = $this->input_filter($args);
        if ($hasFiles) {
            $args['FILES'] = $_FILES;
        }

        $this->output($this->elFinder->exec($cmd, $args));
    }

    /**
     * Output JSON.
     *
     * @param array $data
     */
    public static function outputJson($data)
    {
        // send header
        $header = isset($data['header']) ? $data['header'] : self::$contentType;
        self::sendHeader($header);

        unset($data['header']);

        if (! empty($data['raw']) && ! empty($data['error'])) {
            $out = $data['error'];
        } else {
            if (isset($data['debug']) && isset($data['debug']['phpErrors'])) {
                $data['debug']['phpErrors'] = array_merge($data['debug']['phpErrors'], elFinder::$phpErrors);
            }
            $out = json_encode($data);
        }

        // clear output buffer
        while (ob_get_level() && ob_end_clean()) {

        }

        header('Content-Length: '.strlen($out));

        echo $out;

        flush();
    }

    /**
     * Output json.
     *
     * @param  array  data to output
     * @return void
     * @author Dmitry (dio) Levashov
     **/
    protected function output(array $data)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // unlock session data for multiple access
        $this->elFinder->getSession()->close();
        // client disconnect should abort
        ignore_user_abort(false);

        if ($this->header) {

            self::sendHeader($this->header);

        }

        if (isset($data['pointer'])) {
            // set time limit to 0
            elFinder::extendTimeLimit(0);

            // send optional header
            if (! empty($data['header'])) {
                self::sendHeader($data['header']);
            }

            // clear output buffer
            while (ob_get_level() && ob_end_clean()) {

            }

            $toEnd = true;
            $fp = $data['pointer'];
            if (($this->reqMethod === 'GET' || $this->reqMethod === 'HEAD')
                    && elFinder::isSeekableStream($fp)
                    && (array_search('Accept-Ranges: none', headers_list()) === false)) {
                header('Accept-Ranges: bytes');
                $psize = null;
                if (! empty($_SERVER['HTTP_RANGE'])) {
                    $size = $data['info']['size'];
                    $start = 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                    $end = $size - 1;
                    if (preg_match('/bytes=(\d*)-(\d*)(,?)/i', $_SERVER['HTTP_RANGE'], $matches)) {
                        if (empty($matches[3])) {
                            if (empty($matches[1]) && $matches[1] !== '0') {
                                $start = $size - $matches[2];
                            } else {
                                $start = intval($matches[1]);
                                if (! empty($matches[2])) {
                                    $end = intval($matches[2]);
                                    if ($end >= $size) {
                                        $end = $size - 1;
                                    }
                                    $toEnd = ($end == ($size - 1));
                                }
                            }
                            $psize = $end - $start + 1;

                            header('HTTP/1.1 206 Partial Content');
                            header('Content-Length: '.$psize);
                            header('Content-Range: bytes '.$start.'-'.$end.'/'.$size);

                            fseek($fp, $start);
                        }
                    }
                }
                if (is_null($psize)) {
                    elFinder::rewind($fp);
                }
            } else {
                header('Accept-Ranges: none');
                if (isset($data['info']) && ! $data['info']['size']) {
                    if (function_exists('header_remove')) {
                        header_remove('Content-Length');
                    } else {
                        header('Content-Length:');
                    }
                }
            }

            if ($reqMethod !== 'HEAD') {

                if ($toEnd) {

                    fpassthru($fp);
                } else {
                    $out = fopen('php://output', 'wb');
                    stream_copy_to_stream($fp, $out, $psize);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    fclose($out);
                }
            }

            if (! empty($data['volume'])) {
                $data['volume']->close($data['pointer'], $data['info']['hash']);
            }
            exit();

        } else {
            self::outputJson($data);
            exit(0);

        }
    }

    /**
     * Remove null & stripslashes applies on "magic_quotes_gpc".
     *
     * @param  mixed  $args
     * @return mixed
     * @author Naoki Sawada
     */
    protected function input_filter($args)
    {
        static $magic_quotes_gpc = null;

        if ($magic_quotes_gpc === null) {
            $magic_quotes_gpc = (version_compare(PHP_VERSION, '5.4', '<') && get_magic_quotes_gpc());
        }

        if (is_array($args)) {
            return array_map([&$this, 'input_filter'], $args);
        }
        $res = str_replace("\0", '', $args);
        $magic_quotes_gpc && ($res = stripslashes($res));

        return $res;
    }

    /**
     * Send HTTP header.
     *
     * @param string|array $header optional header
     */
    protected static function sendHeader($header = null)
    {
        if ($header) {
            if (is_array($header)) {
                foreach ($header as $h) {
                    header($h);
                }
            } else {
                header($header);
            }
        }
    }
}// END class


recca0120 / laravel-elfinder

elFinderConnector C last analyzed 2018-02-09 05:57 UTC