ImportCommand::parseContent() - Code Metrics - Inspection of "Merge tag 'v1.3.0' into develop" - libgraviton/import-export - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( b85182...537c08 )

by Narcotic

created 2018-03-12 20:18 UTC

ImportCommand::parseContent() B

↳ Parent: ImportCommand

Complexity

Conditions	5
Paths	5

Size

Total Lines	33
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	11.9355

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	33
ccs	8
cts	23
cp	0.3478
rs	8.439
cc	5
eloc	23
nc	5
nop	2
crap	11.9355

<?php
/**
 * import json data into graviton
 *
 * Supports importing json data from either a single file or a complete folder of files.
 *
 * The data needs to contain frontmatter to hint where the bits and pieces should go.
 */

namespace Graviton\ImportExport\Command;

use Graviton\ImportExport\Exception\MissingTargetException;
use Graviton\ImportExport\Exception\JsonParseException;
use Graviton\ImportExport\Exception\ParseException;
use Graviton\ImportExport\Exception\UnknownFileTypeException;
use Graviton\ImportExport\Service\HttpClient;
use Monolog\Logger;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Yaml\Parser;
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\CliDumper as Dumper;
use GuzzleHttp\Promise;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\Yaml\Yaml;
use Webuni\FrontMatter\FrontMatter;
use Webuni\FrontMatter\Document;

/**
 * @author   List of contributors <https://github.com/libgraviton/import-export/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class ImportCommand extends ImportCommandAbstract
{

    /**
     * @var HttpClient
     */
    private $client;

    /**
     * @var FrontMatter
     */
    private $frontMatter;

    /**
     * @var Parser
     */
    private $parser;

    /**
     * @var VarCloner
     */
    private $cloner;

    /**
     * @var Dumper
     */
    private $dumper;

    /**
     * Count of errors
     * @var array
     */
    private $errors = [];

    /**
     * Header basic auth
     * @var string
     */
    private $headerBasicAuth;

    /**
     * Header for custom variables
     * @var array
     */
    private $customHeaders;

    /**
     * @param Logger      $logger      logger
     * @param HttpClient  $client      Grv HttpClient guzzle http client
     * @param Finder      $finder      symfony/finder instance
     * @param FrontMatter $frontMatter frontmatter parser
     * @param Parser      $parser      yaml/json parser
     * @param VarCloner   $cloner      var cloner for dumping reponses
     * @param Dumper      $dumper      dumper for outputing responses
     */
    public function __construct(
        Logger $logger,
        HttpClient $client,
        Finder $finder,
        FrontMatter $frontMatter,
        Parser $parser,
        VarCloner $cloner,
        Dumper $dumper
    ) {
        parent::__construct(
            $logger,
            $finder
        );
        $this->client = $client;
        $this->frontMatter = $frontMatter;
        $this->parser = $parser;
        $this->cloner = $cloner;
        $this->dumper = $dumper;
    }

    /**
     * Configures the current command.
     *
     * @return void
     */
    protected function configure()
    {
        $this
            ->setName('graviton:import')
            ->setDescription('Import files from a folder or file.')
            ->addOption(
                'rewrite-host',
                'r',
                InputOption::VALUE_OPTIONAL,
                'Replace the value of this option with the <host> value before importing.',
                'http://localhost'
            )
            ->addOption(
                'rewrite-to',
                't',
                InputOption::VALUE_OPTIONAL,
                'String to use as the replacement value for the [REWRITE-HOST] string.',
                '<host>'
            )
            ->addOption(
                'sync-requests',
                's',
                InputOption::VALUE_NONE,
                'Send requests synchronously'
            )
            ->addOption(
                'no-overwrite',
                'o',
                InputOption::VALUE_NONE,
                'If set, we will check for record existence and not overwrite existing ones.'
            )
            ->addOption(
                'headers-basic-auth',
                'a',
                InputOption::VALUE_OPTIONAL,
                'Header user:password for Basic auth'
            )
            ->addOption(
                'custom-headers',
                'c',
                InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
                'Custom Header variable(s), -c{key:value} and multiple is optional.'
            )
            ->addOption(
                'input-file',
                'i',
                InputOption::VALUE_REQUIRED,
                'If provided, the list of files to load will be loaded from this file, one file per line.'
            )
            ->addArgument(
                'host',
                InputArgument::REQUIRED,
                'Protocol and host to load data into (ie. https://graviton.nova.scapp.io)'
            )
            ->addArgument(
                'file',
                InputArgument::IS_ARRAY,
                'Directories or files to load'
            );
    }

    /**
     * Executes the current command.
     *
     * @param Finder          $finder Finder
     * @param InputInterface  $input  User input on console
     * @param OutputInterface $output Output of the command
     *
     * @return integer
     */
    protected function doImport(Finder $finder, InputInterface $input, OutputInterface $output)
    {
        $exitCode = 0;
        $host = $input->getArgument('host');
        $rewriteHost = $input->getOption('rewrite-host');
        $rewriteTo = $input->getOption('rewrite-to');
        $this->headerBasicAuth = $input->getOption('headers-basic-auth');
        $this->customHeaders = $input->getOption('custom-headers');

        if ($rewriteTo === $this->getDefinition()->getOption('rewrite-to')->getDefault()) {
            $rewriteTo = $host;
        }
        $noOverwrite = $input->getOption('no-overwrite');

        $this->importPaths($finder, $output, $host, $rewriteHost, $rewriteTo, $noOverwrite);

        // Error exit
        if (empty($this->errors)) {
            // No errors
            $this->logger->info('No errors');
        } else {
            // Yes, there was errors
            $this->logger->error(
                'There were import errors',
                [
                    'errorCount' => count($this->errors),
                    'errors' => $this->errors
                ]
            );
            $exitCode = 1;
        }
        return $exitCode;
    }

    /**
     * @param Finder          $finder      finder primmed with files to import
     * @param OutputInterface $output      output interfac
     * @param string          $host        host to import into
     * @param string          $rewriteHost string to replace with value from $rewriteTo during loading
     * @param string          $rewriteTo   string to replace value from $rewriteHost with during loading
     * @param boolean         $noOverwrite should we not overwrite existing records?
     *
     * @return void
     *
     * @throws MissingTargetException
     */
    protected function importPaths(
        Finder $finder,
        OutputInterface $output,
        $host,
        $rewriteHost,
        $rewriteTo,
        $noOverwrite = false
    ) {
        /** @var SplFileInfo $file */
        foreach ($finder as $file) {
            $doc = $this->frontMatter->parse($file->getContents());

            $this->logger->info("Loading data from ${file}");

            if (!array_key_exists('target', $doc->getData())) {
                throw new MissingTargetException('Missing target in \'' . $file . '\'');
            }

            $targetUrl = sprintf('%s%s', $host, $doc->getData()['target']);

            $this->importResource(
                $targetUrl,
                (string) $file,
                $output,
                $doc,
                $rewriteHost,
                $rewriteTo,
                $noOverwrite
            );
        }
    }

    /**
     * @param string          $targetUrl   target url to import resource into
     * @param string          $file        path to file being loaded
     * @param OutputInterface $output      output of the command
     * @param Document        $doc         document to load
     * @param string          $rewriteHost string to replace with value from $host during loading
     * @param string          $rewriteTo   string to replace value from $rewriteHost with during loading
     * @param boolean         $noOverwrite should we not overwrite existing records?
     *
     * @return Promise\PromiseInterface|null
     */
    protected function importResource(
        $targetUrl,
        $file,
        OutputInterface $output,
        Document $doc,
        $rewriteHost,
        $rewriteTo,
        $noOverwrite = false
    ) {
        $content = str_replace($rewriteHost, $rewriteTo, $doc->getContent());
        $uploadFile = $this->validateUploadFile($doc, $file);

        $data = [
            'json'   => $this->parseContent($content, $file),
            'upload' => $uploadFile,
            'headers'=> []
        ];

        // Authentication or custom headers.
        if ($this->headerBasicAuth) {
            $data['headers']['Authorization'] = 'Basic '. base64_encode($this->headerBasicAuth);
        }
        if ($this->customHeaders) {

            foreach ($this->customHeaders as $headers) {
                list($key, $value) = explode(':', $headers);
                $data['headers'][$key] = $value;
            }
        }
        if (empty($data['headers'])) {
            unset($data['headers']);
        }

        // skip if no overwriting has been requested
        if ($noOverwrite) {
            $response = $this->client->request('GET', $targetUrl, array_merge($data, ['http_errors' => false]));
            if ($response->getStatusCode() == 200) {
                $this->logger->info(
                    sprintf(
                        'Skipping <%s> as "no overwrite" is activated and it does exist.',
                        $targetUrl
                    )
                );
                return;
            }
        }

        try {
            if ($uploadFile) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                unset($this->errors[$file]);
                try {
                    $this->client->request('DELETE', $targetUrl, $data);
                    $this->logger->info("File deleted: ${targetUrl}");
                } catch (\Exception $e) {
                    $this->logger->error(
                        sprintf(
                            'Failed to delete <%s> with message \'%s\'',
                            $targetUrl,
                            $e->getMessage()
                        ),
                        ['exception' => $e]
                    );
                }
            }

            $response = $this->client->request(
                'PUT',
                $targetUrl,
                $data
            );

            $this->logger->info('Wrote ' . $response->getHeader('Link')[0]);
        } catch (\Exception $e) {
            $this->errors[$file] = $e->getMessage();
            $this->logger->error(
                sprintf(
                    'Failed to write <%s> from \'%s\' with message \'%s\'',
                    $e->getRequest()->getUri(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    $file,
                    $e->getMessage()
                ),
                ['exception' => $e]
            );
            if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                $this->dumper->dump(
                    $this->cloner->cloneVar(
                        $this->parser->parse($e->getResponse()->getBody(), Yaml::PARSE_OBJECT_FOR_MAP)
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    ),
                    function ($line, $depth) use ($output) {
                        if ($depth > 0) {
                            $output->writeln(
                                '<error>' . str_pad(str_repeat('  ', $depth) . $line, 140, ' ') . '</error>'
                            );
                        }
                    }
                );
            }
        }
    }

    /**
     * parse contents of a file depending on type
     *
     * @param string $content contents part of file
     * @param string $file    full path to file
     *
     * @return mixed
     * @throws UnknownFileTypeException
     * @throws ParseException
     */
    protected function parseContent($content, $file)
    {
        if (substr($file, -5) == '.json') {
            $data = json_decode($content);
            if (json_last_error() !== JSON_ERROR_NONE) {
                throw new ParseException(
                    sprintf(
                        '%s in %s',
                        json_last_error_msg(),
                        $file
                    )
                );
            }
        } elseif (substr($file, -4) == '.yml') {
            try {
                $data = $this->parser->parse($content);
            } catch (\Exception $e) {
                throw new ParseException(
                    sprintf(
                        'YAML parse error in file %s, message = %s',
                        $file,
                        $e->getMessage()
                    ),
                    0,
                    $e
                );
            }
        } else {
            throw new UnknownFileTypeException($file);
        }

        return $data;
    }

    /**
     * Checks if file exists and return qualified fileName location
     *
     * @param Document $doc        Data source for import data
     * @param string   $originFile Original full filename used toimport
     * @return bool|mixed
     */
    private function validateUploadFile(Document $doc, $originFile)
    {
        $documentData = $doc->getData();

        if (!array_key_exists('file', $documentData)) {
            return false;
        }

        // Find file
        $fileName = dirname($originFile) . DIRECTORY_SEPARATOR . $documentData['file'];
        $fileName = str_replace('//', '/', $fileName);
        if (!file_exists($fileName)) {
            return false;
        }

        return $fileName;
    }
}


Push — develop ( b85182...537c08 )

ImportCommand::parseContent() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2		/**
3		* import json data into graviton
4		*
5		* Supports importing json data from either a single file or a complete folder of files.
6		*
7		* The data needs to contain frontmatter to hint where the bits and pieces should go.
8		*/
9
10		namespace Graviton\ImportExport\Command;
11
12		use Graviton\ImportExport\Exception\MissingTargetException;
13		use Graviton\ImportExport\Exception\JsonParseException;
14		use Graviton\ImportExport\Exception\ParseException;
15		use Graviton\ImportExport\Exception\UnknownFileTypeException;
16		use Graviton\ImportExport\Service\HttpClient;
17		use Monolog\Logger;
18		use Symfony\Component\Console\Input\InputArgument;
19		use Symfony\Component\Console\Input\InputOption;
20		use Symfony\Component\Console\Input\InputInterface;
21		use Symfony\Component\Console\Output\OutputInterface;
22		use Symfony\Component\Finder\Finder;
23		use Symfony\Component\Yaml\Parser;
24		use Symfony\Component\VarDumper\Cloner\VarCloner;
25		use Symfony\Component\VarDumper\Dumper\CliDumper as Dumper;
26		use GuzzleHttp\Promise;
27		use Symfony\Component\Finder\SplFileInfo;
28		use Symfony\Component\Yaml\Yaml;
29		use Webuni\FrontMatter\FrontMatter;
30		use Webuni\FrontMatter\Document;
31
32		/**
33		* @author List of contributors <https://github.com/libgraviton/import-export/graphs/contributors>
34		* @license http://opensource.org/licenses/gpl-license.php GNU Public License
35		* @link http://swisscom.ch
36		*/
37		class ImportCommand extends ImportCommandAbstract
38		{
39
40		/**
41		* @var HttpClient
42		*/
43		private $client;
44
45		/**
46		* @var FrontMatter
47		*/
48		private $frontMatter;
49
50		/**
51		* @var Parser
52		*/
53		private $parser;
54
55		/**
56		* @var VarCloner
57		*/
58		private $cloner;
59
60		/**
61		* @var Dumper
62		*/
63		private $dumper;
64
65		/**
66		* Count of errors
67		* @var array
68		*/
69		private $errors = [];
70
71		/**
72		* Header basic auth
73		* @var string
74		*/
75		private $headerBasicAuth;
76
77		/**
78		* Header for custom variables
79		* @var array
80		*/
81		private $customHeaders;
82
83		/**
84		* @param Logger $logger logger
85		* @param HttpClient $client Grv HttpClient guzzle http client
86		* @param Finder $finder symfony/finder instance
87		* @param FrontMatter $frontMatter frontmatter parser
88		* @param Parser $parser yaml/json parser
89		* @param VarCloner $cloner var cloner for dumping reponses
90		* @param Dumper $dumper dumper for outputing responses
91		*/
92	5	public function __construct(
93		Logger $logger,
94		HttpClient $client,
95		Finder $finder,
96		FrontMatter $frontMatter,
97		Parser $parser,
98		VarCloner $cloner,
99		Dumper $dumper
100		) {
101	5	parent::__construct(
102	5	$logger,
103		$finder
104	5	);
105	5	$this->client = $client;
106	5	$this->frontMatter = $frontMatter;
107	5	$this->parser = $parser;
108	5	$this->cloner = $cloner;
109	5	$this->dumper = $dumper;
110	5	}
111
112		/**
113		* Configures the current command.
114		*
115		* @return void
116		*/
117	5	protected function configure()
118		{
119	5	$this
120	5	->setName('graviton:import')
121	5	->setDescription('Import files from a folder or file.')
122	5	->addOption(
123	5	'rewrite-host',
124	5	'r',
125	5	InputOption::VALUE_OPTIONAL,
126	5	'Replace the value of this option with the <host> value before importing.',
127		'http://localhost'
128	5	)
129	5	->addOption(
130	5	'rewrite-to',
131	5	't',
132	5	InputOption::VALUE_OPTIONAL,
133	5	'String to use as the replacement value for the [REWRITE-HOST] string.',
134		'<host>'
135	5	)
136	5	->addOption(
137	5	'sync-requests',
138	5	's',
139	5	InputOption::VALUE_NONE,
140		'Send requests synchronously'
141	5	)
142	5	->addOption(
143	5	'no-overwrite',
144	5	'o',
145	5	InputOption::VALUE_NONE,
146		'If set, we will check for record existence and not overwrite existing ones.'
147	5	)
148	5	->addOption(
149	5	'headers-basic-auth',
150	5	'a',
151	5	InputOption::VALUE_OPTIONAL,
152		'Header user:password for Basic auth'
153	5	)
154	5	->addOption(
155	5	'custom-headers',
156	5	'c',
157	5	InputOption::VALUE_OPTIONAL \| InputOption::VALUE_IS_ARRAY,
158		'Custom Header variable(s), -c{key:value} and multiple is optional.'
159	5	)
160	5	->addOption(
161	5	'input-file',
162	5	'i',
163	5	InputOption::VALUE_REQUIRED,
164		'If provided, the list of files to load will be loaded from this file, one file per line.'
165	5	)
166	5	->addArgument(
167	5	'host',
168	5	InputArgument::REQUIRED,
169		'Protocol and host to load data into (ie. https://graviton.nova.scapp.io)'
170	5	)
171	5	->addArgument(
172	5	'file',
173	5	InputArgument::IS_ARRAY,
174		'Directories or files to load'
175	5	);
176	5	}
177
178		/**
179		* Executes the current command.
180		*
181		* @param Finder $finder Finder
182		* @param InputInterface $input User input on console
183		* @param OutputInterface $output Output of the command
184		*
185		* @return integer
186		*/
187	5	protected function doImport(Finder $finder, InputInterface $input, OutputInterface $output)
188		{
189	5	$exitCode = 0;
190	5	$host = $input->getArgument('host');
191	5	$rewriteHost = $input->getOption('rewrite-host');
192	5	$rewriteTo = $input->getOption('rewrite-to');
193	5	$this->headerBasicAuth = $input->getOption('headers-basic-auth');
194	5	$this->customHeaders = $input->getOption('custom-headers');
		0 ignored issues – show Documentation Bug introduced 2017-08-10 08:24 UTC by Report Bug Copy Issue Report It seems like `$input->getOption('custom-headers')` of type `*` is incompatible with the declared type `array` of property `$customHeaders`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
195	5	if ($rewriteTo === $this->getDefinition()->getOption('rewrite-to')->getDefault()) {
196	5	$rewriteTo = $host;
197	5	}
198	5	$noOverwrite = $input->getOption('no-overwrite');
199
200	5	$this->importPaths($finder, $output, $host, $rewriteHost, $rewriteTo, $noOverwrite);
201
202		// Error exit
203	4	if (empty($this->errors)) {
204		// No errors
205	3	$this->logger->info('No errors');
206	3	} else {
207		// Yes, there was errors
208	1	$this->logger->error(
209	1	'There were import errors',
210		[
211	1	'errorCount' => count($this->errors),
212	1	'errors' => $this->errors
213	1	]
214	1	);
215	1	$exitCode = 1;
216		}
217	4	return $exitCode;
218		}
219
220		/**
221		* @param Finder $finder finder primmed with files to import
222		* @param OutputInterface $output output interfac
223		* @param string $host host to import into
224		* @param string $rewriteHost string to replace with value from $rewriteTo during loading
225		* @param string $rewriteTo string to replace value from $rewriteHost with during loading
226		* @param boolean $noOverwrite should we not overwrite existing records?
227		*
228		* @return void
229		*
230		* @throws MissingTargetException
231		*/
232	5	protected function importPaths(
233	1	Finder $finder,
234		OutputInterface $output,
235		$host,
236		$rewriteHost,
237		$rewriteTo,
238		$noOverwrite = false
239		) {
240		/** @var SplFileInfo $file */
241	5	foreach ($finder as $file) {
242	5	$doc = $this->frontMatter->parse($file->getContents());
243
244	5	$this->logger->info("Loading data from ${file}");
245
246	5	if (!array_key_exists('target', $doc->getData())) {
247	1	throw new MissingTargetException('Missing target in \'' . $file . '\'');
248		}
249
250	4	$targetUrl = sprintf('%s%s', $host, $doc->getData()['target']);
251
252	4	$this->importResource(
253	4	$targetUrl,
254	4	(string) $file,
255	4	$output,
256	4	$doc,
257	4	$rewriteHost,
258	4	$rewriteTo,
259		$noOverwrite
260	4	);
261	4	}
262		}
263
264		/**
265		* @param string $targetUrl target url to import resource into
266		* @param string $file path to file being loaded
267		* @param OutputInterface $output output of the command
268		* @param Document $doc document to load
269		* @param string $rewriteHost string to replace with value from $host during loading
270		* @param string $rewriteTo string to replace value from $rewriteHost with during loading
271		* @param boolean $noOverwrite should we not overwrite existing records?
272		*
273		* @return Promise\PromiseInterface\|null
274		*/
275		protected function importResource(
276		$targetUrl,
277		$file,
278		OutputInterface $output,
279		Document $doc,
280		$rewriteHost,
281		$rewriteTo,
282		$noOverwrite = false
283		) {
284	4	$content = str_replace($rewriteHost, $rewriteTo, $doc->getContent());
285	4	$uploadFile = $this->validateUploadFile($doc, $file);
286
287		$data = [
288	4	'json' => $this->parseContent($content, $file),
289	4	'upload' => $uploadFile,
290	4	'headers'=> []
291	4	];
292
293		// Authentication or custom headers.
294	4	if ($this->headerBasicAuth) {
295		$data['headers']['Authorization'] = 'Basic '. base64_encode($this->headerBasicAuth);
296		}
297	4	if ($this->customHeaders) {
		0 ignored issues – show Bug Best Practice introduced 2017-07-04 14:35 UTC by Report Bug Copy Issue Report The expression `$this->customHeaders` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
298		foreach ($this->customHeaders as $headers) {
299		list($key, $value) = explode(':', $headers);
300		$data['headers'][$key] = $value;
301		}
302		}
303	4	if (empty($data['headers'])) {
304	4	unset($data['headers']);
305	4	}
306
307		// skip if no overwriting has been requested
308	4	if ($noOverwrite) {
309		$response = $this->client->request('GET', $targetUrl, array_merge($data, ['http_errors' => false]));
310		if ($response->getStatusCode() == 200) {
311		$this->logger->info(
312		sprintf(
313		'Skipping <%s> as "no overwrite" is activated and it does exist.',
314		$targetUrl
315		)
316		);
317		return;
318		}
319		}
320
321		try {
322	4	if ($uploadFile) {
		0 ignored issues – show Bug Best Practice introduced 2018-01-16 16:25 UTC by Report Bug Copy Issue Report The expression `$uploadFile` of type `false\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
323	1	unset($this->errors[$file]);
324		try {
325	1	$this->client->request('DELETE', $targetUrl, $data);
326	1	$this->logger->info("File deleted: ${targetUrl}");
327	1	} catch (\Exception $e) {
328		$this->logger->error(
329		sprintf(
330		'Failed to delete <%s> with message \'%s\'',
331		$targetUrl,
332		$e->getMessage()
333		),
334		['exception' => $e]
335		);
336		}
337	1	}
338
339	4	$response = $this->client->request(
340	4	'PUT',
341	4	$targetUrl,
342		$data
343	4	);
344
345	3	$this->logger->info('Wrote ' . $response->getHeader('Link')[0]);
346	4	} catch (\Exception $e) {
347	1	$this->errors[$file] = $e->getMessage();
348	1	$this->logger->error(
349	1	sprintf(
350	1	'Failed to write <%s> from \'%s\' with message \'%s\'',
351	1	$e->getRequest()->getUri(),
		0 ignored issues – show Bug introduced 2018-01-16 16:25 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getRequest()` does only exist in the following sub-classes of `Exception`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
352	1	$file,
353	1	$e->getMessage()
354	1	),
355	1	['exception' => $e]
356	1	);
357	1	if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
358	1	$this->dumper->dump(
359	1	$this->cloner->cloneVar(
360	1	$this->parser->parse($e->getResponse()->getBody(), Yaml::PARSE_OBJECT_FOR_MAP)
		0 ignored issues – show Bug introduced 2018-02-27 12:44 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getResponse()` does only exist in the following sub-classes of `Exception`: `GuzzleHttp\Exception\BadResponseException`, `GuzzleHttp\Exception\ClientException`, `GuzzleHttp\Exception\ConnectException`, `GuzzleHttp\Exception\RequestException`, `GuzzleHttp\Exception\ServerException`, `GuzzleHttp\Exception\TooManyRedirectsException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
361	1	),
362		function ($line, $depth) use ($output) {
363	1	if ($depth > 0) {
364	1	$output->writeln(
365	1	'<error>' . str_pad(str_repeat(' ', $depth) . $line, 140, ' ') . '</error>'
366	1	);
367	1	}
368	1	}
369	1	);
370	1	}
371		}
372	4	}
373
374		/**
375		* parse contents of a file depending on type
376		*
377		* @param string $content contents part of file
378		* @param string $file full path to file
379		*
380		* @return mixed
381		* @throws UnknownFileTypeException
382		* @throws ParseException
383		*/
384		protected function parseContent($content, $file)
385		{
386	4	if (substr($file, -5) == '.json') {
387	3	$data = json_decode($content);
388	3	if (json_last_error() !== JSON_ERROR_NONE) {
389		throw new ParseException(
390		sprintf(
391		'%s in %s',
392		json_last_error_msg(),
393		$file
394		)
395		);
396		}
397	4	} elseif (substr($file, -4) == '.yml') {
398		try {
399	1	$data = $this->parser->parse($content);
400	1	} catch (\Exception $e) {
401		throw new ParseException(
402		sprintf(
403		'YAML parse error in file %s, message = %s',
404		$file,
405		$e->getMessage()
406		),
407		0,
408		$e
409		);
410		}
411	1	} else {
412		throw new UnknownFileTypeException($file);
413		}
414
415	4	return $data;
416		}
417
418		/**
419		* Checks if file exists and return qualified fileName location
420		*
421		* @param Document $doc Data source for import data
422		* @param string $originFile Original full filename used toimport
423		* @return bool\|mixed
424		*/
425		private function validateUploadFile(Document $doc, $originFile)
426		{
427	4	$documentData = $doc->getData();
428
429	4	if (!array_key_exists('file', $documentData)) {
430	3	return false;
431		}
432
433		// Find file
434	1	$fileName = dirname($originFile) . DIRECTORY_SEPARATOR . $documentData['file'];
435	1	$fileName = str_replace('//', '/', $fileName);
436	1	if (!file_exists($fileName)) {
437		return false;
438		}
439
440	1	return $fileName;
441		}
442		}
443

libgraviton / import-export

Push — develop ( b85182...537c08 )

ImportCommand::parseContent() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like