TikaRestClient::getGuzzleOptions() - Code Metrics - Inspection of "Merge pull request #47 from creative-commoners/pul..." - silverstripe/silverstripe-textextraction - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b20738...03d1fe )

unknown

created 2018-07-08 21:57 UTC

TikaRestClient::getGuzzleOptions() A

↳ Parent: TikaRestClient

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	2
nop	1
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php

namespace SilverStripe\TextExtraction\Rest;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\Response;
use Psr\Log\LoggerInterface;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Environment;
use SilverStripe\Core\Injector\Injector;

class TikaRestClient extends Client
{
    /**
     * Authentication options to be sent to the Tika server
     *
     * @var array
     */
    protected $options = ['username' => null, 'password' => null];

    /**
     * @var array
     */
    protected $mimes = [];

    /**
     *
     * @param string $baseUrl
     * @param array $config
     */
    public function __construct($baseUrl = '', $config = [])
    {
        $password = Environment::getEnv('SS_TIKA_PASSWORD');

        if (!empty($password)) {
            $this->options = [
                'username' => Environment::getEnv('SS_TIKA_USERNAME'),
                'password' => $password,
            ];
        }

        $config['base_uri'] = $baseUrl;

        parent::__construct($config);
    }

    /**
     * Detect if the service is available
     *
     * @return bool
     */
    public function isAvailable()
    {
        try {
            /** @var Response $result */
            $result = $this->get('/', $this->getGuzzleOptions());

            if ($result->getStatusCode() == 200) {
                return true;
            }
        } catch (RequestException $ex) {
            $msg = sprintf("Tika unavailable - %s", $ex->getMessage());
            Injector::inst()->get(LoggerInterface::class)->info($msg);

            return false;
        }
    }

    /**
     * Get version code
     *
     * @return float
     */
    public function getVersion()
    {
        /** @var Response $response */
        $response = $this->get('version', $this->getGuzzleOptions());
        $version = 0.0;

        // Parse output
        if ($response->getStatusCode() == 200
            && preg_match('/Apache Tika (?<version>[\.\d]+)/', $response->getBody(), $matches)
        ) {
            $version = (float)$matches['version'];
        }

        return $version;
    }

    /**
     * Gets supported mime data. May include aliased mime types.
     *
     * @return array
     */
    public function getSupportedMimes()
    {
        if ($this->mimes) {

            return $this->mimes;
        }

        $response = $this->get(
            'mime-types',
            $this->getGuzzleOptions([
                'headers' => [
                    'Accept' => 'application/json',
                ],
            ])
        );

        return $this->mimes = Convert::json2array($response->getBody());
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Extract text content from a given file.
     * Logs a notice-level error if the document can't be parsed.
     *
     * @param  string $file Full filesystem path to a file to post
     * @return string Content of the file extracted as plain text
     */
    public function tika($file)
    {
        $text = null;
        try {
            /** @var Response $response */
            $response = $this->put(
                'tika',
                $this->getGuzzleOptions([
                    'headers' => [
                        'Accept' => 'text/plain',
                    ],
                    'body' => file_get_contents($file),
                ])
            );
            $text = $response->getBody();
        } catch (RequestException $e) {
            $msg = sprintf(
                'TikaRestClient was not able to process %s. Response: %s %s.',
                $file,
                $e->getResponse()->getStatusCode(),
                $e->getResponse()->getReasonPhrase()
            );
            // Only available if tika-server was started with --includeStack
            $body = $e->getResponse()->getBody();
            if ($body) {

                $msg .= ' Body: ' . $body;
            }

            Injector::inst()->get(LoggerInterface::class)->info($msg);
        }

        return $text;
    }

    /**
     * Assembles an array of request options to pass to Guzzle
     *
     * @param array $options Authentication (etc) will be merged into this array and returned
     * @return array
     */
    protected function getGuzzleOptions($options = [])
    {
        if (!empty($this->options['username']) && !empty($this->options['password'])) {
            $options['auth'] = [
                $this->options['username'],
                $this->options['password']
            ];
        }
        return $options;
    }
}


1			<?php
2
3			namespace SilverStripe\TextExtraction\Rest;
4
5			use GuzzleHttp\Client;
6			use GuzzleHttp\Exception\RequestException;
7			use GuzzleHttp\Psr7\Response;
8			use Psr\Log\LoggerInterface;
9			use SilverStripe\Core\Convert;
10			use SilverStripe\Core\Environment;
11			use SilverStripe\Core\Injector\Injector;
12
13			class TikaRestClient extends Client
14			{
15			/**
16			* Authentication options to be sent to the Tika server
17			*
18			* @var array
19			*/
20			protected $options = ['username' => null, 'password' => null];
21
22			/**
23			* @var array
24			*/
25			protected $mimes = [];
26
27			/**
28			*
29			* @param string $baseUrl
30			* @param array $config
31			*/
32			public function __construct($baseUrl = '', $config = [])
33			{
34			$password = Environment::getEnv('SS_TIKA_PASSWORD');
35
36			if (!empty($password)) {
37			$this->options = [
38			'username' => Environment::getEnv('SS_TIKA_USERNAME'),
39			'password' => $password,
40			];
41			}
42
43			$config['base_uri'] = $baseUrl;
44
45			parent::__construct($config);
46			}
47
48			/**
49			* Detect if the service is available
50			*
51			* @return bool
52			*/
53			public function isAvailable()
54			{
55			try {
56			/** @var Response $result */
57			$result = $this->get('/', $this->getGuzzleOptions());
58
59			if ($result->getStatusCode() == 200) {
60			return true;
61			}
62			} catch (RequestException $ex) {
63			$msg = sprintf("Tika unavailable - %s", $ex->getMessage());
64			Injector::inst()->get(LoggerInterface::class)->info($msg);
65
66			return false;
67			}
68			}
69
70			/**
71			* Get version code
72			*
73			* @return float
74			*/
75			public function getVersion()
76			{
77			/** @var Response $response */
78			$response = $this->get('version', $this->getGuzzleOptions());
79			$version = 0.0;
80
81			// Parse output
82			if ($response->getStatusCode() == 200
83			&& preg_match('/Apache Tika (?<version>[\.\d]+)/', $response->getBody(), $matches)
84			) {
85			$version = (float)$matches['version'];
86			}
87
88			return $version;
89			}
90
91			/**
92			* Gets supported mime data. May include aliased mime types.
93			*
94			* @return array
95			*/
96			public function getSupportedMimes()
97			{
98			if ($this->mimes) {
			0 ignored issues – show Bug Best Practice introduced 2018-07-03 05:40 UTC by Report Bug Copy Issue Report The expression `$this->mimes` 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...
99			return $this->mimes;
100			}
101
102			$response = $this->get(
103			'mime-types',
104			$this->getGuzzleOptions([
105			'headers' => [
106			'Accept' => 'application/json',
107			],
108			])
109			);
110
111			return $this->mimes = Convert::json2array($response->getBody());
			0 ignored issues – show Documentation Bug introduced 2018-07-06 04:15 UTC by Report Bug Copy Issue Report It seems like `SilverStripe\Core\Conver...y($response->getBody())` can also be of type `boolean`. However, the property `$mimes` is declared as type `array`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history... Bug Best Practice introduced 2018-07-06 04:15 UTC by Report Bug Copy Issue Report The expression `return $this->mimes = Si...y($response->getBody())` also could return the type `boolean` which is incompatible with the documented return type `array`. Loading history...
112			}
113
114			/**
115			* Extract text content from a given file.
116			* Logs a notice-level error if the document can't be parsed.
117			*
118			* @param string $file Full filesystem path to a file to post
119			* @return string Content of the file extracted as plain text
120			*/
121			public function tika($file)
122			{
123			$text = null;
124			try {
125			/** @var Response $response */
126			$response = $this->put(
127			'tika',
128			$this->getGuzzleOptions([
129			'headers' => [
130			'Accept' => 'text/plain',
131			],
132			'body' => file_get_contents($file),
133			])
134			);
135			$text = $response->getBody();
136			} catch (RequestException $e) {
137			$msg = sprintf(
138			'TikaRestClient was not able to process %s. Response: %s %s.',
139			$file,
140			$e->getResponse()->getStatusCode(),
141			$e->getResponse()->getReasonPhrase()
142			);
143			// Only available if tika-server was started with --includeStack
144			$body = $e->getResponse()->getBody();
145			if ($body) {
			0 ignored issues – show introduced 2018-07-03 05:40 UTC by Report Bug Copy Issue Report `$body` is of type `Psr\Http\Message\StreamInterface`, thus it always evaluated to `true`. Loading history...
146			$msg .= ' Body: ' . $body;
147			}
148
149			Injector::inst()->get(LoggerInterface::class)->info($msg);
150			}
151
152			return $text;
153			}
154
155			/**
156			* Assembles an array of request options to pass to Guzzle
157			*
158			* @param array $options Authentication (etc) will be merged into this array and returned
159			* @return array
160			*/
161			protected function getGuzzleOptions($options = [])
162			{
163			if (!empty($this->options['username']) && !empty($this->options['password'])) {
164			$options['auth'] = [
165			$this->options['username'],
166			$this->options['password']
167			];
168			}
169			return $options;
170			}
171			}
172

silverstripe / silverstripe-textextraction

Push — master ( b20738...03d1fe )

TikaRestClient::getGuzzleOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like