Downloader::getEasyRSA() - Code Metrics - EvilFreelancer/easyrsa-php - Measure and Improve Code Quality continuously with Scrutinizer

Downloader::getEasyRSA() A
last analyzed 2020-07-29 05:00 UTC

↳ Parent: Downloader

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

declare(strict_types=1);

namespace EasyRSA;

use EasyRSA\Interfaces\DownloaderInterface;
use splitbrain\PHPArchive\Tar;

class Downloader extends Worker implements DownloaderInterface
{
    /**
     * Url via which possible to get the latest release of EasyRSA.
     */
    public const URL_LATEST_RELEASE = 'https://api.github.com/repos/OpenVPN/easy-rsa/releases/latest';

    /**
     * Exec some operation by cURL.
     *
     * @param string      $url
     * @param string|null $filename
     *
     * @return string|null
     */
    private function curlExec(string $url, string $filename = null): ?string
    {
        $curl = curl_init();

        curl_setopt($curl, CURLOPT_USERAGENT, 'useragent');
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_URL, $url);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);

        // If filename is not set
        if (null !== $filename) {
            $fp = fopen($filename, 'wb+');
            curl_setopt($curl, CURLOPT_FILE, $fp);
        }

        $result = curl_exec($curl);
        curl_close($curl);

        return is_bool($result) ? null : $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getLatestVersion(): string
    {
        $json = $this->curlExec(self::URL_LATEST_RELEASE);
        $json = json_decode($json, true, 512, JSON_THROW_ON_ERROR);

        return $json['tarball_url'];
    }

    /**
     * {@inheritdoc}
     */
    public function downloadLatestVersion(): ?string
    {
        // Get full path to archive file
        $filename = $this->config->getArchive();

        // Get url with latest release
        $latest = $this->getLatestVersion();

        // Download and return status
        return $this->curlExec($latest, $filename);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritdoc}
     *
     * @throws \splitbrain\PHPArchive\ArchiveIllegalCompressionException If archive is broken
     * @throws \splitbrain\PHPArchive\ArchiveIOException If not possible to read archive
     * @throws \splitbrain\PHPArchive\ArchiveCorruptedException If archive corrupted
     */
    public function extractArchive(): array
    {
        $tar = new Tar();
        $tar->open($this->config->get('archive'));

        $tar->extract($this->config->get('scripts'), 1);


        return $tar->contents();
    }

    /**
     * {@inheritdoc}
     *
     * @throws \splitbrain\PHPArchive\ArchiveIllegalCompressionException If archive is broken
     * @throws \splitbrain\PHPArchive\ArchiveIOException If not possible to read archive
     * @throws \splitbrain\PHPArchive\ArchiveCorruptedException If archive corrupted
     */
    public function getEasyRSA(): void
    {
        $this->downloadLatestVersion();
        $this->extractArchive();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace EasyRSA;
6
7			use EasyRSA\Interfaces\DownloaderInterface;
8			use splitbrain\PHPArchive\Tar;
9
10			class Downloader extends Worker implements DownloaderInterface
11			{
12			/**
13			* Url via which possible to get the latest release of EasyRSA.
14			*/
15			public const URL_LATEST_RELEASE = 'https://api.github.com/repos/OpenVPN/easy-rsa/releases/latest';
16
17			/**
18			* Exec some operation by cURL.
19			*
20			* @param string $url
21			* @param string\|null $filename
22			*
23			* @return string\|null
24			*/
25			private function curlExec(string $url, string $filename = null): ?string
26			{
27			$curl = curl_init();
28
29			curl_setopt($curl, CURLOPT_USERAGENT, 'useragent');
30			curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
31			curl_setopt($curl, CURLOPT_URL, $url);
32			curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
33
34			// If filename is not set
35			if (null !== $filename) {
36			$fp = fopen($filename, 'wb+');
37			curl_setopt($curl, CURLOPT_FILE, $fp);
38			}
39
40			$result = curl_exec($curl);
41			curl_close($curl);
42
43			return is_bool($result) ? null : $result;
44			}
45
46			/**
47			* {@inheritdoc}
48			*/
49			public function getLatestVersion(): string
50			{
51			$json = $this->curlExec(self::URL_LATEST_RELEASE);
52			$json = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
53
54			return $json['tarball_url'];
55			}
56
57			/**
58			* {@inheritdoc}
59			*/
60			public function downloadLatestVersion(): ?string
61			{
62			// Get full path to archive file
63			$filename = $this->config->getArchive();
64
65			// Get url with latest release
66			$latest = $this->getLatestVersion();
67
68			// Download and return status
69			return $this->curlExec($latest, $filename);
			0 ignored issues – show Bug Best Practice introduced 2020-07-10 21:12 UTC by Report Bug Copy Issue Report The return type of `return $this->curlExec($latest, $filename);` (`object\|integer\|double\|string\|null\|array`) is incompatible with the return type declared by the interface `EasyRSA\Interfaces\Downl...::downloadLatestVersion` of type `string\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
70			}
71
72			/**
73			* {@inheritdoc}
74			*
75			* @throws \splitbrain\PHPArchive\ArchiveIllegalCompressionException If archive is broken
76			* @throws \splitbrain\PHPArchive\ArchiveIOException If not possible to read archive
77			* @throws \splitbrain\PHPArchive\ArchiveCorruptedException If archive corrupted
78			*/
79			public function extractArchive(): array
80			{
81			$tar = new Tar();
82			$tar->open($this->config->get('archive'));
			0 ignored issues – show Bug introduced 2020-07-10 21:12 UTC by Report Bug Copy Issue Report It seems like `$this->config->get('archive')` targeting `EasyRSA\Interfaces\ConfigInterface::get()` can also be of type `boolean` or `null`; however, `splitbrain\PHPArchive\Tar::open()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
83			$tar->extract($this->config->get('scripts'), 1);
			0 ignored issues – show Bug introduced 2020-07-10 21:12 UTC by Report Bug Copy Issue Report It seems like `$this->config->get('scripts')` targeting `EasyRSA\Interfaces\ConfigInterface::get()` can also be of type `boolean` or `null`; however, `splitbrain\PHPArchive\Tar::extract()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
84
85			return $tar->contents();
86			}
87
88			/**
89			* {@inheritdoc}
90			*
91			* @throws \splitbrain\PHPArchive\ArchiveIllegalCompressionException If archive is broken
92			* @throws \splitbrain\PHPArchive\ArchiveIOException If not possible to read archive
93			* @throws \splitbrain\PHPArchive\ArchiveCorruptedException If archive corrupted
94			*/
95			public function getEasyRSA(): void
96			{
97			$this->downloadLatestVersion();
98			$this->extractArchive();
99			}
100			}
101

EvilFreelancer / easyrsa-php

Downloader::getEasyRSA() A last analyzed 2020-07-29 05:00 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Downloader::getEasyRSA() A
last analyzed 2020-07-29 05:00 UTC