librenms/librenms

View on GitHub
LibreNMS/Config.php

Summary

Maintainability
C
1 day
Test Coverage

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processConfig accesses the super-global variable $_SERVER.
Open

    private static function processConfig()
    {
        // If we're on SSL, let's properly detect it
        if (
            isset($_SERVER['HTTPS']) ||
Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processConfig accesses the super-global variable $_SERVER.
Open

    private static function processConfig()
    {
        // If we're on SSL, let's properly detect it
        if (
            isset($_SERVER['HTTPS']) ||
Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processDefaults accesses the super-global variable $_SERVER.
Open

    private static function processDefaults()
    {
        Arr::set(self::$config, 'log_dir', base_path('logs'));
        Arr::set(self::$config, 'distributed_poller_name', php_uname('n'));

Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

processConfig accesses the super-global variable $_SERVER.
Open

    private static function processConfig()
    {
        // If we're on SSL, let's properly detect it
        if (
            isset($_SERVER['HTTPS']) ||
Severity: Minor
Found in LibreNMS/Config.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

File Config.php has 337 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Config.php
 *
 * Config convenience class to access and set config variables.
Severity: Minor
Found in LibreNMS/Config.php - About 4 hrs to fix

    The class Config has an overall complexity of 76 which is very high. The configured complexity threshold is 50.
    Open

    class Config
    {
        private static $config;
    
        /**
    Severity: Minor
    Found in LibreNMS/Config.php by phpmd

    Config has 26 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Config
    {
        private static $config;
    
        /**
    Severity: Minor
    Found in LibreNMS/Config.php - About 3 hrs to fix

      Method processConfig has 54 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private static function processConfig()
          {
              // If we're on SSL, let's properly detect it
              if (
                  isset($_SERVER['HTTPS']) ||
      Severity: Major
      Found in LibreNMS/Config.php - About 2 hrs to fix

        Function processConfig has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
        Open

            private static function processConfig()
            {
                // If we're on SSL, let's properly detect it
                if (
                    isset($_SERVER['HTTPS']) ||
        Severity: Minor
        Found in LibreNMS/Config.php - About 1 hr to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function loadGraphsFromDb has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            private static function loadGraphsFromDb(&$config)
            {
                try {
                    $graph_types = GraphType::all()->toArray();
                } catch (QueryException $e) {
        Severity: Minor
        Found in LibreNMS/Config.php - About 45 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function locateBinary has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            public static function locateBinary($binary)
            {
                if (! Str::contains($binary, '/')) {
                    $output = `whereis -b $binary`;
                    $list = trim(substr($output, strpos($output, ':') + 1));
        Severity: Minor
        Found in LibreNMS/Config.php - About 25 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Function getCombined has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            public static function getCombined(?string $os, string $key, string $global_prefix = '', array $default = []): array
            {
                $global_key = $global_prefix . $key;
        
                if (! isset(self::$config['os'][$os][$key])) {
        Severity: Minor
        Found in LibreNMS/Config.php - About 25 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        The method processConfig() has an NPath complexity of 1536. The configured NPath complexity threshold is 200.
        Open

            private static function processConfig()
            {
                // If we're on SSL, let's properly detect it
                if (
                    isset($_SERVER['HTTPS']) ||
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        NPathComplexity

        Since: 0.1

        The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

        Example

        class Foo {
            function bar() {
                // lots of complicated code
            }
        }

        Source https://phpmd.org/rules/codesize.html#npathcomplexity

        The method processConfig() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
        Open

            private static function processConfig()
            {
                // If we're on SSL, let's properly detect it
                if (
                    isset($_SERVER['HTTPS']) ||
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        CyclomaticComplexity

        Since: 0.1

        Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

        Example

        // Cyclomatic Complexity = 11
        class Foo {
        1   public function example() {
        2       if ($a == $b) {
        3           if ($a1 == $b1) {
                        fiddle();
        4           } elseif ($a2 == $b2) {
                        fiddle();
                    } else {
                        fiddle();
                    }
        5       } elseif ($c == $d) {
        6           while ($c == $d) {
                        fiddle();
                    }
        7        } elseif ($e == $f) {
        8           for ($n = 0; $n < $h; $n++) {
                        fiddle();
                    }
                } else {
                    switch ($z) {
        9               case 1:
                            fiddle();
                            break;
        10              case 2:
                            fiddle();
                            break;
        11              case 3:
                            fiddle();
                            break;
                        default:
                            fiddle();
                            break;
                    }
                }
            }
        }

        Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

        Remove error control operator '@' on line 119.
        Open

            private static function loadUserConfigFile(&$config)
            {
                // Load user config file
                if (is_file(base_path('config.php'))) {
                    @include base_path('config.php');
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ErrorControlOperator

        Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

        Example

        function foo($filePath) {
            $file = @fopen($filPath); // hides exceptions
            $key = @$array[$notExistingKey]; // assigns null to $key
        }

        Source http://phpmd.org/rules/cleancode.html#errorcontroloperator

        The method loadGraphsFromDb uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
        Open

                        } else {
                            $key = $k;
                        }
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ElseExpression

        Since: 1.4.0

        An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

        Example

        class Foo
        {
            public function bar($flag)
            {
                if ($flag) {
                    // one branch
                } else {
                    // another branch
                }
            }
        }

        Source https://phpmd.org/rules/cleancode.html#elseexpression

        The method setDefault uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
        Open

                    } else {
                        self::set($key, $value);
                    }
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ElseExpression

        Since: 1.4.0

        An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

        Example

        class Foo
        {
            public function bar($flag)
            {
                if ($flag) {
                    // one branch
                } else {
                    // another branch
                }
            }
        }

        Source https://phpmd.org/rules/cleancode.html#elseexpression

        Avoid unused parameters such as '$config'.
        Open

            private static function loadUserConfigFile(&$config)
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        UnusedFormalParameter

        Since: 0.2

        Avoid passing parameters to methods or constructors and then not using those parameters.

        Example

        class Foo
        {
            private function bar($howdy)
            {
                // $howdy is not used
            }
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

        FIXME found
        Open

        //        self::setDefault('email_from', '"%s" <%s@' . php_uname('n') . '>', ['project_name', 'email_user']);  // FIXME email_from set because alerting config
        Severity: Minor
        Found in LibreNMS/Config.php by fixme

        Avoid variables with short names like $os. Configured minimum length is 3.
        Open

            public static function getOsSetting($os, $key, $default = null)
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $os. Configured minimum length is 3.
        Open

            public static function getCombined(?string $os, string $key, string $global_prefix = '', array $default = []): array
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $g. Configured minimum length is 3.
        Open

                    $g = [];
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

        Source https://phpmd.org/rules/naming.html#shortvariable

        Avoid variables with short names like $db. Configured minimum length is 3.
        Open

                $db = config('database.default');
        Severity: Minor
        Found in LibreNMS/Config.php by phpmd

        ShortVariable

        Since: 0.2

        Detects when a field, local, or parameter has a very short name.

        Example

        class Something {
            private $q = 15; // VIOLATION - Field
            public static function main( array $as ) { // VIOLATION - Formal
                $r = 20 + $this->q; // VIOLATION - Local
                for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                    $r += $this->q;
                }
            }
        }

        Source https://phpmd.org/rules/naming.html#shortvariable

        Expected 0 spaces after opening bracket; newline found
        Open

                if (
        Severity: Minor
        Found in LibreNMS/Config.php by phpcodesniffer

        There are no issues that match your filters.

        Category
        Status