Ftp::read() - Code Metrics - Inspection of "Added some text to the readme" - johnnymast/redbox-scan - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — release/1.0 ( 656514...db7b8d )

by Johnny

created 2015-12-22 17:39 UTC

Ftp::read() B

↳ Parent: Ftp

Complexity

Conditions	5
Paths	6

Size

Total Lines	19
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
c	2
b	0
f	2
dl	0
loc	19
rs	8.8571
cc	5
eloc	15
nc	6
nop	0

<?php
namespace Redbox\Scan\Adapter;
use Symfony\Component\Yaml;
use Redbox\Scan\Report;

/**
 * Read and write files from a given ftp location.
 * see examples/ftp.php for a demonstration.
 *
 * @package Redbox\Scan\Adapter
 */
class Ftp implements AdapterInterface
{
    const FTP_MODE_ASCII  = FTP_ASCII;
    const FTP_MODE_BINARY = FTP_BINARY;

    protected $host = '';
    protected $username = '';
    protected $password = '';
    protected $filename = '';
    protected $port     = 21;

    protected $timeout  = 90;
    protected $handle   = null;

    /**
     * You might think just connect to the ftp server from the constructor
     * but psr-4 dictates that autoloadable classes MUST NOT...
     *
     * Quote:
     * Autoloader implementations MUST NOT throw exceptions, MUST NOT raise errors of any level, and SHOULD NOT return a value.
     *
     * So we need to use authenticate() after we construct.
     *
     * @param string $host
     * @param string $username
     * @param string $password
     * @param string $filename
     * @param int $port;
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param int $timeout
     */
    public function __construct($host = "", $username = "", $password = "", $filename = "", $port = 21, $timeout = 90)
    {
        $this->host     = $host;
        $this->username = $username;
        $this->password = $password;
        $this->filename = $filename;
        $this->timeout  = $timeout;
        $this->port     = $port;
    }

    /**
     * We should be so nice to terminate the construction of we are done.
     */
    public function __destruct() {
        if ($this->handle) {
            ftp_close($this->handle);
        }
    }

    public function authenticate() {
        $this->handle = ftp_connect($this->host, $this->port, $this->timeout);
        if (!$this->handle) // TODO: Reevaluate this
            return false;

        return ftp_login($this->handle, $this->username, $this->password);
    }

    /**
     * Read the previous scan results from the file system.
     *
     * @return array
     */
    public function read() {
        $stream = fopen('php://memory', 'w');
        $data   = '';
        if (!$stream) return false;
        if ($ret = ftp_nb_fget($this->handle, $stream, $this->filename, self::FTP_MODE_ASCII)) {
            while ($ret === FTP_MOREDATA) {
                rewind($stream);
                $data .=  stream_get_contents($stream);
                $ret = ftp_nb_continue($this->handle);
            }
            if ($ret != FTP_FINISHED) {
               return false;
            } else {
                $data = Yaml\Yaml::parse($data);
                return $data;
            }
        }
        return false;
    }

    // TODO: This should be an universial exception
    /**
     * Write the report to the filesystem so we can reuse it
     * at a later stace when we invoke Redbox\Scan\ScanService's scan() method.
     *
     * @param Report\Report|null $report
     * @return bool
     */
    public function write(Report\Report $report = null) {
        if ($report) {
            $stream = fopen('php://memory', 'w+');
            if (!$stream) return false;
            $data = $report->toArray();
            $data = Yaml\Yaml::dump($data, 99);

            fwrite($stream, $data);
            rewind($stream);
       //     fclose($stream);

            if(ftp_fput($this->handle, $this->filename, $stream, self::FTP_MODE_ASCII)) {
                return true;
            } else {
                return false;
            }
        }
        return false;
    }

}

1			<?php
2			namespace Redbox\Scan\Adapter;
3			use Symfony\Component\Yaml;
4			use Redbox\Scan\Report;
5
6			/**
7			* Read and write files from a given ftp location.
8			* see examples/ftp.php for a demonstration.
9			*
10			* @package Redbox\Scan\Adapter
11			*/
12			class Ftp implements AdapterInterface
13			{
14			const FTP_MODE_ASCII = FTP_ASCII;
15			const FTP_MODE_BINARY = FTP_BINARY;
16
17			protected $host = '';
18			protected $username = '';
19			protected $password = '';
20			protected $filename = '';
21			protected $port = 21;
22
23			protected $timeout = 90;
24			protected $handle = null;
25
26			/**
27			* You might think just connect to the ftp server from the constructor
28			* but psr-4 dictates that autoloadable classes MUST NOT...
29			*
30			* Quote:
31			* Autoloader implementations MUST NOT throw exceptions, MUST NOT raise errors of any level, and SHOULD NOT return a value.
32			*
33			* So we need to use authenticate() after we construct.
34			*
35			* @param string $host
36			* @param string $username
37			* @param string $password
38			* @param string $filename
39			* @param int $port;
			0 ignored issues – show Bug introduced 2015-12-22 17:42 UTC by Report Bug Copy Issue Report There is no parameter named `$port;`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
40			* @param int $timeout
41			*/
42			public function __construct($host = "", $username = "", $password = "", $filename = "", $port = 21, $timeout = 90)
43			{
44			$this->host = $host;
45			$this->username = $username;
46			$this->password = $password;
47			$this->filename = $filename;
48			$this->timeout = $timeout;
49			$this->port = $port;
50			}
51
52			/**
53			* We should be so nice to terminate the construction of we are done.
54			*/
55			public function __destruct() {
56			if ($this->handle) {
57			ftp_close($this->handle);
58			}
59			}
60
61			public function authenticate() {
62			$this->handle = ftp_connect($this->host, $this->port, $this->timeout);
63			if (!$this->handle) // TODO: Reevaluate this
64			return false;
65
66			return ftp_login($this->handle, $this->username, $this->password);
67			}
68
69			/**
70			* Read the previous scan results from the file system.
71			*
72			* @return array
73			*/
74			public function read() {
75			$stream = fopen('php://memory', 'w');
76			$data = '';
77			if (!$stream) return false;
78			if ($ret = ftp_nb_fget($this->handle, $stream, $this->filename, self::FTP_MODE_ASCII)) {
79			while ($ret === FTP_MOREDATA) {
80			rewind($stream);
81			$data .= stream_get_contents($stream);
82			$ret = ftp_nb_continue($this->handle);
83			}
84			if ($ret != FTP_FINISHED) {
85			return false;
86			} else {
87			$data = Yaml\Yaml::parse($data);
88			return $data;
89			}
90			}
91			return false;
92			}
93
94			// TODO: This should be an universial exception
95			/**
96			* Write the report to the filesystem so we can reuse it
97			* at a later stace when we invoke Redbox\Scan\ScanService's scan() method.
98			*
99			* @param Report\Report\|null $report
100			* @return bool
101			*/
102			public function write(Report\Report $report = null) {
103			if ($report) {
104			$stream = fopen('php://memory', 'w+');
105			if (!$stream) return false;
106			$data = $report->toArray();
107			$data = Yaml\Yaml::dump($data, 99);
108
109			fwrite($stream, $data);
110			rewind($stream);
111			// fclose($stream);
112
113			if(ftp_fput($this->handle, $this->filename, $stream, self::FTP_MODE_ASCII)) {
114			return true;
115			} else {
116			return false;
117			}
118			}
119			return false;
120			}
121
122			}

johnnymast / redbox-scan

Push — release/1.0 ( 656514...db7b8d )

Ftp::read() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like