rugk/threema-msgapi-sdk-php

View on GitHub
source/Threema/MsgApi/Helpers/E2EHelper.php

Summary

Maintainability
D
2 days
Test Coverage

Function receiveMessage has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring.
Open

    public final function receiveMessage($threemaId,
                                         $messageId,
                                         $box,
                                         $nonce,
                                         $outputFolder = null,
Severity: Minor
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 5 hrs 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

Method receiveMessage has 68 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public final function receiveMessage($threemaId,
                                         $messageId,
                                         $box,
                                         $nonce,
                                         $outputFolder = null,
Severity: Major
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 2 hrs to fix

Method sendFileMessage has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public final function sendFileMessage($threemaId, $filePath, $thumbnailPath = null) {
        //analyse the file
        $fileAnalyzeResult = FileAnalysisTool::analyse($filePath);

        if(null === $fileAnalyzeResult) {
Severity: Minor
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 1 hr to fix

Method sendImageMessage has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public final function sendImageMessage($threemaId, $imagePath) {
        //analyse the file
        $fileAnalyzeResult = FileAnalysisTool::analyse($imagePath);

        if(null === $fileAnalyzeResult) {
Severity: Minor
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 1 hr to fix

Method checkMac has 8 arguments (exceeds 4 allowed). Consider refactoring.
Open

    public final function checkMac($threemaId, $gatewayId, $messageId, $date, $nonce, $box, $mac, $secret) {
Severity: Major
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 1 hr to fix

Method receiveMessage has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

    public final function receiveMessage($threemaId,
                                         $messageId,
                                         $box,
                                         $nonce,
                                         $outputFolder = null,
Severity: Minor
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 45 mins to fix

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

    public final function sendFileMessage($threemaId, $filePath, $thumbnailPath = null) {
        //analyse the file
        $fileAnalyzeResult = FileAnalysisTool::analyse($filePath);

        if(null === $fileAnalyzeResult) {
Severity: Minor
Found in source/Threema/MsgApi/Helpers/E2EHelper.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

The method receiveMessage() has an NPath complexity of 1566. The configured NPath complexity threshold is 200.
Open

    public final function receiveMessage($threemaId,
                                         $messageId,
                                         $box,
                                         $nonce,
                                         $outputFolder = null,

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 receiveMessage() has a Cyclomatic Complexity of 21. The configured cyclomatic complexity threshold is 10.
Open

    public final function receiveMessage($threemaId,
                                         $messageId,
                                         $box,
                                         $nonce,
                                         $outputFolder = null,

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

The class E2EHelper has a coupling between objects value of 16. Consider to reduce the number of dependencies under 13.
Open

class E2EHelper {
    /**
     * @var Connection
     */
    private $connection;

CouplingBetweenObjects

Since: 1.1.0

A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

Example

class Foo {
    /**
     * @var \foo\bar\X
     */
    private $x = null;

    /**
     * @var \foo\bar\Y
     */
    private $y = null;

    /**
     * @var \foo\bar\Z
     */
    private $z = null;

    public function setFoo(\Foo $foo) {}
    public function setBar(\Bar $bar) {}
    public function setBaz(\Baz $baz) {}

    /**
     * @return \SplObjectStorage
     * @throws \OutOfRangeException
     * @throws \InvalidArgumentException
     * @throws \ErrorException
     */
    public function process(\Iterator $it) {}

    // ...
}

Source https://phpmd.org/rules/design.html#couplingbetweenobjects

Avoid using static access to class '\Threema\MsgApi\Tools\FileAnalysisTool' in method 'sendFileMessage'.
Open

        $fileAnalyzeResult = FileAnalysisTool::analyse($filePath);

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

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

Avoid using static access to class '\Threema\MsgApi\Tools\FileAnalysisTool' in method 'sendImageMessage'.
Open

        $fileAnalyzeResult = FileAnalysisTool::analyse($imagePath);

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

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

Avoid using static access to class '\Threema\MsgApi\Tools\CryptTool' in method '__construct'.
Open

            $this->cryptTool = CryptTool::getInstance();

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

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

Similar blocks of code found in 2 locations. Consider refactoring.
Open

                if(null !== $result && true === $result->isSuccess()) {
                    $file = $this->cryptTool->decryptFileThumbnail(
                        $result->getData(),
                        $this->cryptTool->hex2bin($message->getEncryptionKey()));

Severity: Major
Found in source/Threema/MsgApi/Helpers/E2EHelper.php and 1 other location - About 2 hrs to fix
source/Threema/MsgApi/Helpers/E2EHelper.php on lines 261..275

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 131.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

            if(null !== $result && true === $result->isSuccess()) {
                $file = $this->cryptTool->decryptFile(
                    $result->getData(),
                    $this->cryptTool->hex2bin($message->getEncryptionKey()));

Severity: Major
Found in source/Threema/MsgApi/Helpers/E2EHelper.php and 1 other location - About 2 hrs to fix
source/Threema/MsgApi/Helpers/E2EHelper.php on lines 279..292

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 131.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Avoid excessively long variable names like $thumbnailUploadResult. Keep variable name length under 20.
Open

        $thumbnailUploadResult = null;

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

Avoid excessively long variable names like $thumbnailEncryptionResult. Keep variable name length under 20.
Open

            $thumbnailEncryptionResult = $this->cryptTool->encryptFileThumbnail(file_get_contents($thumbnailPath), $encryptionResult->getKey());

LongVariable

Since: 0.2

Detects when a field, formal or local variable is declared with a long name.

Example

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

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

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

                $f = fopen($filePath, 'w+');

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

There are no issues that match your filters.

Category
Status