TikaServerTextExtractor::getServerEndpoint() - Code Metrics - silverstripe/silverstripe-textextraction - Measure and Improve Code Quality continuously with Scrutinizer

TikaServerTextExtractor::getServerEndpoint() A
last analyzed 2019-11-05 02:08 UTC

↳ Parent: TikaServerTextExtractor

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php

namespace SilverStripe\TextExtraction\Extractor;

use SilverStripe\Assets\File;
use SilverStripe\Core\Environment;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\TextExtraction\Rest\TikaRestClient;

/**
 * Enables text extraction of file content via the Tika Rest Server
 *
 * {@link http://tika.apache.org/1.7/gettingstarted.html}
 */
class TikaServerTextExtractor extends FileTextExtractor
{
    /**
     * Tika server is pretty efficient so use it immediately if available
     *
     * @var integer
     * @config
     */
    private static $priority = 80;


    /**
     * Server endpoint
     *
     * @var string
     * @config
     */
    private static $server_endpoint;


    /**
     * @var TikaRestClient
     */
    protected $client = null;

    /**
     * Cache of supported mime types
     *
     * @var array
     */
    protected $supportedMimes = [];

    /**
     * @return TikaRestClient
     */
    public function getClient()
    {
        if (!$this->client) {
            $this->client = Injector::inst()->createWithArgs(
                TikaRestClient::class,
                [$this->getServerEndpoint()]
            );
        }
        return $this->client;
    }

    /**
     * @return string
     */
    public function getServerEndpoint()
    {
        if ($endpoint = Environment::getEnv('SS_TIKA_ENDPOINT')) {
            return $endpoint;
        }

        // Default to configured endpoint
        return $this->config()->get('server_endpoint');
    }

    /**
     * Get the version of Tika installed, or 0 if not installed
     *
     * @return float version of Tika
     */
    public function getVersion()
    {
        return $this->getClient()->getVersion();

    }

    /**
     * @return boolean
     */
    public function isAvailable()
    {
        return $this->getServerEndpoint()
            && $this->getClient()->isAvailable()
            && version_compare($this->getVersion(), '1.7') >= 0;
    }

    /**
     * @param  string $extension
     * @return boolean
     */
    public function supportsExtension($extension)
    {
        // Determine support via mime type only
        return false;
    }

    /**
     * @param  string $mime
     * @return boolean
     */
    public function supportsMime($mime)
    {
        if (!$this->supportedMimes) {

            $this->supportedMimes = (array) $this->getClient()->getSupportedMimes();
        }

        // Check if supported (most common / quickest lookup)
        if (isset($this->supportedMimes[$mime])) {
            return true;
        }

        // Check aliases
        foreach ($this->supportedMimes as $info) {
            if (isset($info['alias']) && in_array($mime, $info['alias'])) {
                return true;
            }
        }

        return false;
    }

    public function getContent($file)
    {
        $tempFile = $file instanceof File ? $this->getPathFromFile($file) : $file;
        $content = $this->getClient()->tika($tempFile);
        //Cleanup temp file
        if ($file instanceof File) {
            unlink($tempFile);
        }
        return $content;
    }
}


1			<?php
2
3			namespace SilverStripe\TextExtraction\Extractor;
4
5			use SilverStripe\Assets\File;
6			use SilverStripe\Core\Environment;
7			use SilverStripe\Core\Injector\Injector;
8			use SilverStripe\TextExtraction\Rest\TikaRestClient;
9
10			/**
11			* Enables text extraction of file content via the Tika Rest Server
12			*
13			* {@link http://tika.apache.org/1.7/gettingstarted.html}
14			*/
15			class TikaServerTextExtractor extends FileTextExtractor
16			{
17			/**
18			* Tika server is pretty efficient so use it immediately if available
19			*
20			* @var integer
21			* @config
22			*/
23			private static $priority = 80;
			0 ignored issues – show introduced 2018-07-03 05:40 UTC by Report Bug Copy Issue Report The private property `$priority` is not used, and could be removed. Loading history...
24
25			/**
26			* Server endpoint
27			*
28			* @var string
29			* @config
30			*/
31			private static $server_endpoint;
			0 ignored issues – show introduced 2018-07-03 05:40 UTC by Report Bug Copy Issue Report The private property `$server_endpoint` is not used, and could be removed. Loading history...
32
33			/**
34			* @var TikaRestClient
35			*/
36			protected $client = null;
37
38			/**
39			* Cache of supported mime types
40			*
41			* @var array
42			*/
43			protected $supportedMimes = [];
44
45			/**
46			* @return TikaRestClient
47			*/
48			public function getClient()
49			{
50			if (!$this->client) {
51			$this->client = Injector::inst()->createWithArgs(
52			TikaRestClient::class,
53			[$this->getServerEndpoint()]
54			);
55			}
56			return $this->client;
57			}
58
59			/**
60			* @return string
61			*/
62			public function getServerEndpoint()
63			{
64			if ($endpoint = Environment::getEnv('SS_TIKA_ENDPOINT')) {
65			return $endpoint;
66			}
67
68			// Default to configured endpoint
69			return $this->config()->get('server_endpoint');
70			}
71
72			/**
73			* Get the version of Tika installed, or 0 if not installed
74			*
75			* @return float version of Tika
76			*/
77			public function getVersion()
78			{
79			return $this->getClient()->getVersion();
			0 ignored issues – show Bug Best Practice introduced 2019-03-25 03:18 UTC by Report Bug Copy Issue Report The expression `return $this->getClient()->getVersion()` returns the type `string` which is incompatible with the documented return type `double`. Loading history...
80			}
81
82			/**
83			* @return boolean
84			*/
85			public function isAvailable()
86			{
87			return $this->getServerEndpoint()
88			&& $this->getClient()->isAvailable()
89			&& version_compare($this->getVersion(), '1.7') >= 0;
90			}
91
92			/**
93			* @param string $extension
94			* @return boolean
95			*/
96			public function supportsExtension($extension)
97			{
98			// Determine support via mime type only
99			return false;
100			}
101
102			/**
103			* @param string $mime
104			* @return boolean
105			*/
106			public function supportsMime($mime)
107			{
108			if (!$this->supportedMimes) {
			0 ignored issues – show Bug Best Practice introduced 2018-07-03 05:40 UTC by Report Bug Copy Issue Report The expression `$this->supportedMimes` 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...
109			$this->supportedMimes = (array) $this->getClient()->getSupportedMimes();
110			}
111
112			// Check if supported (most common / quickest lookup)
113			if (isset($this->supportedMimes[$mime])) {
114			return true;
115			}
116
117			// Check aliases
118			foreach ($this->supportedMimes as $info) {
119			if (isset($info['alias']) && in_array($mime, $info['alias'])) {
120			return true;
121			}
122			}
123
124			return false;
125			}
126
127			public function getContent($file)
128			{
129			$tempFile = $file instanceof File ? $this->getPathFromFile($file) : $file;
130			$content = $this->getClient()->tika($tempFile);
131			//Cleanup temp file
132			if ($file instanceof File) {
133			unlink($tempFile);
134			}
135			return $content;
136			}
137			}
138

silverstripe / silverstripe-textextraction

TikaServerTextExtractor::getServerEndpoint() A last analyzed 2019-11-05 02:08 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TikaServerTextExtractor::getServerEndpoint() A
last analyzed 2019-11-05 02:08 UTC