Videos::getTitleExact() - Code Metrics - Inspection of "Check for query returning null value" - NNTmux/newznab-tmux - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev ( e23b16...63cc84 )

by Darko

created 2019-11-22 21:59 UTC

Videos::getTitleExact() B

↳ Parent: Videos

Complexity

Conditions	7
Paths	21

Size

Total Lines	28
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	18
c	1
b	0
f	0
dl	0
loc	28
ccs	0
cts	15
cp	0
rs	8.8333
cc	7
nc	21
nop	3
crap	56

<?php
/**
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program (see LICENSE.txt in the base directory.  If
 * not, see:
 *
 * @link      <http://www.gnu.org/licenses/>.
 * @author    niel
 * @copyright 2015 nZEDb
 */

namespace Blacklight\processing;

use App\Models\TvInfo;
use App\Models\Video;
use App\Models\VideoAlias;
use Illuminate\Support\Facades\Cache;

/**
 * Parent class for TV/Film and any similar classes to inherit from.
 */
abstract class Videos
{
    // Video Type Identifiers
    protected const TYPE_TV = 0; // Type of video is a TV Programme/Show
    protected const TYPE_FILM = 1; // Type of video is a Film/Movie
    protected const TYPE_ANIME = 2; // Type of video is a Anime

    /**
     * @var bool
     */
    public $echooutput;

    /**
     * @var array	sites	The sites that we have an ID columns for in our video table.
     */
    private static $sites = ['imdb', 'tmdb', 'trakt', 'tvdb', 'tvmaze', 'tvrage'];

    /**
     * @var array Temp Array of cached failed lookups
     */
    public $titleCache;

    public function __construct(array $options = [])
    {
        $defaults = [
            'Echo'     => false,
            'Settings' => null,
        ];
        $options += $defaults;

        $this->echooutput = ($options['Echo'] && config('nntmux.echocli'));
        $this->titleCache = [];
    }

    /**
     * Main processing director function for scrapers
     * Calls work query function and initiates processing.
     *
     * @param      $groupID
     * @param      $guidChar
     * @param      $process
     * @param bool $local
     */
    abstract protected function processSite($groupID, $guidChar, $process, $local = false): void;

    /**
     * Get video info from a Video ID and column.
     *
     * @param string  $siteColumn
     * @param int $videoID
     *
     * @return array|false    False if invalid site, or ID not found; Site id value otherwise.
     */
    protected function getSiteIDFromVideoID($siteColumn, $videoID)
    {
        if (\in_array($siteColumn, self::$sites, false)) {
            $result = Video::query()->where('id', $videoID)->first([$siteColumn]);

            return $result !== null ? $result[$siteColumn] : false;
        }

        return false;
    }

    /**
     * Get TV show local timezone from a Video ID.
     *
     * @param int $videoID
     *
     * @return string Empty string if no query return or tz style timezone
     */
    protected function getLocalZoneFromVideoID($videoID): string
    {
        $result = TvInfo::query()->where('videos_id', $videoID)->first(['localzone']);

        return $result !== null ? $result['localzone'] : '';
    }

    /**
     * Get video info from a Site ID and column.
     *
     *
     * @param $siteColumn
     * @param $siteID
     * @return bool|int
     */
    protected function getVideoIDFromSiteID($siteColumn, $siteID)
    {
        $result = null;
        if (\in_array($siteColumn, self::$sites, false)) {
            $result = Video::query()->where($siteColumn, $siteID)->first(['id']);
        }

        return $result !== null ? $result->id : false;
    }

    /**
     * Attempt a local lookup via the title first by exact match and then by like.
     * Returns a false for no match or the Video ID of the match.
     *
     * @param        $title
     * @param        $type
     * @param int    $source
     *
     * @return false|int
     */
    public function getByTitle($title, $type, $source = 0)
    {
        // Check if we already have an entry for this show.
        $res = $this->getTitleExact($title, $type, $source);
        if (isset($res)) {
            return $res;

        }

        $title2 = str_replace(' and ', ' & ', $title);
        if ((string) $title !== (string) $title2) {
            $res = $this->getTitleExact($title2, $type, $source);
            if (isset($res)) {
                return $res;

            }
            $pieces = explode(' ', $title2);
            $title2 = '%';
            foreach ($pieces as $piece) {
                $title2 .= str_replace(["'", '!'], '', $piece).'%';
            }
            $res = $this->getTitleLoose($title2, $type, $source);
            if (isset($res)) {
                return $res;
            }
        }

        // Some words are spelled correctly 2 ways
        // example theatre and theater
        $title2 = str_replace('er', 're', $title);
        if ((string) $title !== (string) $title2) {
            $res = $this->getTitleExact($title2, $type, $source);
            if (isset($res['id'])) {
                return $res['id'];
            }
            $pieces = explode(' ', $title2);
            $title2 = '%';
            foreach ($pieces as $piece) {
                $title2 .= str_replace(["'", '!'], '', $piece).'%';
            }
            $res = $this->getTitleLoose($title2, $type, $source);
            if (isset($res)) {
                return $res;
            }
        } else {

            // If there was not an exact title match, look for title with missing chars
            // example release name :Zorro 1990, tvrage name Zorro (1990)
            // Only search if the title contains more than one word to prevent incorrect matches
            $pieces = explode(' ', $title);
            if (\count($pieces) > 1) {
                $title2 = '%';
                foreach ($pieces as $piece) {
                    $title2 .= str_replace(["'", '!'], '', $piece).'%';
                }
                $res = $this->getTitleLoose($title2, $type, $source);
                if (isset($res)) {
                    return $res;
                }
            }
        }

        return false;
    }

    /**
     * @param $title
     * @param $type
     * @param int $source
     * @return bool|\Illuminate\Database\Eloquent\Model|null|static
     */
    public function getTitleExact($title, $type, $source = 0)
    {
        $return = false;
        if (! empty($title)) {
            $sql = Video::query()->where(['title' => $title, 'type' => $type]);
            if ($source > 0) {
                $sql->where('source', $source);
            }
            $query = $sql->first();
            if (! empty($query)) {
                $return = $query->value('id');
            }
            // Try for an alias
            if (empty($return)) {
                $sql = Video::query()
                    ->join('videos_aliases', 'videos.id', '=', 'videos_aliases.videos_id')
                    ->where(['videos_aliases.title' => $title, 'videos.type' => $type]);
                if ($source > 0) {
                    $sql->where('videos.source', $source);
                }
                $query = $sql->first();
                if (! empty($query)) {
                    $return = $query->value('videos.id');
                }
            }
        }

        return $return;
    }

    /**
     * Supplementary function for getByTitle that queries for a like match.
     *
     * @param        $title
     * @param        $type
     * @param int    $source
     *
     * @return array|false
     */
    public function getTitleLoose($title, $type, $source = 0)
    {
        $return = false;

        if (! empty($title)) {
            $sql = Video::query()
                ->where('title', 'like', rtrim($title, '%'))
                ->where('type', $type);
            if ($source > 0) {
                $sql->where('source', $source);
            }
            $return = $sql->first()->value('id');
            // Try for an alias
            if (empty($return)) {
                $sql = Video::query()
                    ->join('videos_aliases', 'videos.id', '=', 'videos_aliases.videos_id')
                    ->where('videos_aliases.title', '=', rtrim($title, '%'))
                    ->where('type', $type);
                if ($source > 0) {
                    $sql->where('videos.source', $source);
                }
                $return = $sql->first()->value('videos.id');
            }
        }

        return $return;

    }

    /**
     * Inserts aliases for videos.
     *
     * @param       $videoId
     * @param array $aliases
     */
    public function addAliases($videoId, array $aliases = []): void
    {
        if (! empty($aliases) && $videoId > 0) {
            foreach ($aliases as $key => $title) {
                // Check for tvmaze style aka
                if (\is_array($title) && ! empty($title['name'])) {
                    $title = $title['name'];
                }
                // Check if we have the AKA already
                $check = $this->getAliases($videoId, $title);

                if ($check === false) {
                    VideoAlias::insertOrIgnore(['videos_id' => $videoId, 'title' => $title, 'created_at' => now(), 'updated_at' => now()]);
                }
            }
        }
    }

    /**
     * Retrieves all aliases for given VideoID or VideoID for a given alias.
     *
     *
     * @param int $videoId
     * @param string $alias
     * @return VideoAlias[]|bool|\Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection|mixed
     */
    public function getAliases(int $videoId, string $alias = '')
    {
        $return = false;
        $expiresAt = now()->addMinutes(config('nntmux.cache_expiry_medium'));

        if ($videoId > 0 || $alias !== '') {
            $aliasCache = Cache::get(md5($videoId.$alias));
            if ($aliasCache !== null) {
                $return = $aliasCache;
            } else {
                $sql = VideoAlias::query();
                if ($videoId > 0) {
                    $sql->where('videos_id', $videoId);
                } elseif ($alias !== '') {
                    $sql->where('title', $alias);
                }
                $return = $sql->get();
                Cache::put(md5($videoId.$alias), $return, $expiresAt);
            }
        }

        return $return->isEmpty() ? false : $return;
    }
}


1			<?php
2			/**
3			* This program is free software: you can redistribute it and/or modify
4			* it under the terms of the GNU General Public License as published by
5			* the Free Software Foundation, either version 3 of the License, or
6			* (at your option) any later version.
7			*
8			* This program is distributed in the hope that it will be useful,
9			* but WITHOUT ANY WARRANTY; without even the implied warranty of
10			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11			* GNU General Public License for more details.
12			*
13			* You should have received a copy of the GNU General Public License
14			* along with this program (see LICENSE.txt in the base directory. If
15			* not, see:
16			*
17			* @link <http://www.gnu.org/licenses/>.
18			* @author niel
19			* @copyright 2015 nZEDb
20			*/
21
22			namespace Blacklight\processing;
23
24			use App\Models\TvInfo;
25			use App\Models\Video;
26			use App\Models\VideoAlias;
27			use Illuminate\Support\Facades\Cache;
28
29			/**
30			* Parent class for TV/Film and any similar classes to inherit from.
31			*/
32			abstract class Videos
33			{
34			// Video Type Identifiers
35			protected const TYPE_TV = 0; // Type of video is a TV Programme/Show
36			protected const TYPE_FILM = 1; // Type of video is a Film/Movie
37			protected const TYPE_ANIME = 2; // Type of video is a Anime
38
39			/**
40			* @var bool
41			*/
42			public $echooutput;
43
44			/**
45			* @var array sites The sites that we have an ID columns for in our video table.
46			*/
47			private static $sites = ['imdb', 'tmdb', 'trakt', 'tvdb', 'tvmaze', 'tvrage'];
48
49			/**
50			* @var array Temp Array of cached failed lookups
51			*/
52			public $titleCache;
53
54			public function __construct(array $options = [])
55			{
56			$defaults = [
57			'Echo' => false,
58			'Settings' => null,
59			];
60			$options += $defaults;
61
62			$this->echooutput = ($options['Echo'] && config('nntmux.echocli'));
63			$this->titleCache = [];
64			}
65
66			/**
67			* Main processing director function for scrapers
68			* Calls work query function and initiates processing.
69			*
70			* @param $groupID
71			* @param $guidChar
72			* @param $process
73			* @param bool $local
74			*/
75			abstract protected function processSite($groupID, $guidChar, $process, $local = false): void;
76
77			/**
78			* Get video info from a Video ID and column.
79			*
80			* @param string $siteColumn
81			* @param int $videoID
82			*
83			* @return array\|false False if invalid site, or ID not found; Site id value otherwise.
84			*/
85			protected function getSiteIDFromVideoID($siteColumn, $videoID)
86			{
87			if (\in_array($siteColumn, self::$sites, false)) {
88			$result = Video::query()->where('id', $videoID)->first([$siteColumn]);
89
90			return $result !== null ? $result[$siteColumn] : false;
91			}
92
93			return false;
94			}
95
96			/**
97			* Get TV show local timezone from a Video ID.
98			*
99			* @param int $videoID
100			*
101			* @return string Empty string if no query return or tz style timezone
102			*/
103			protected function getLocalZoneFromVideoID($videoID): string
104			{
105			$result = TvInfo::query()->where('videos_id', $videoID)->first(['localzone']);
106
107			return $result !== null ? $result['localzone'] : '';
108			}
109
110			/**
111			* Get video info from a Site ID and column.
112			*
113			*
114			* @param $siteColumn
115			* @param $siteID
116			* @return bool\|int
117			*/
118			protected function getVideoIDFromSiteID($siteColumn, $siteID)
119			{
120			$result = null;
121			if (\in_array($siteColumn, self::$sites, false)) {
122			$result = Video::query()->where($siteColumn, $siteID)->first(['id']);
123			}
124
125			return $result !== null ? $result->id : false;
126			}
127
128			/**
129			* Attempt a local lookup via the title first by exact match and then by like.
130			* Returns a false for no match or the Video ID of the match.
131			*
132			* @param $title
133			* @param $type
134			* @param int $source
135			*
136			* @return false\|int
137			*/
138			public function getByTitle($title, $type, $source = 0)
139			{
140			// Check if we already have an entry for this show.
141			$res = $this->getTitleExact($title, $type, $source);
142			if (isset($res)) {
143			return $res;
			0 ignored issues – show Bug Best Practice introduced 2019-11-22 19:47 UTC by Report Bug Copy Issue Report The expression `return $res` returns the type `Illuminate\Database\Eloquent\Model` which is incompatible with the documented return type `false\|integer`. Loading history...
144			}
145
146			$title2 = str_replace(' and ', ' & ', $title);
147			if ((string) $title !== (string) $title2) {
148			$res = $this->getTitleExact($title2, $type, $source);
149			if (isset($res)) {
150			return $res;
			0 ignored issues – show Bug Best Practice introduced 2019-11-22 19:47 UTC by Report Bug Copy Issue Report The expression `return $res` returns the type `Illuminate\Database\Eloquent\Model` which is incompatible with the documented return type `false\|integer`. Loading history...
151			}
152			$pieces = explode(' ', $title2);
153			$title2 = '%';
154			foreach ($pieces as $piece) {
155			$title2 .= str_replace(["'", '!'], '', $piece).'%';
156			}
157			$res = $this->getTitleLoose($title2, $type, $source);
158			if (isset($res)) {
159			return $res;
160			}
161			}
162
163			// Some words are spelled correctly 2 ways
164			// example theatre and theater
165			$title2 = str_replace('er', 're', $title);
166			if ((string) $title !== (string) $title2) {
167			$res = $this->getTitleExact($title2, $type, $source);
168			if (isset($res['id'])) {
169			return $res['id'];
170			}
171			$pieces = explode(' ', $title2);
172			$title2 = '%';
173			foreach ($pieces as $piece) {
174			$title2 .= str_replace(["'", '!'], '', $piece).'%';
175			}
176			$res = $this->getTitleLoose($title2, $type, $source);
177			if (isset($res)) {
178			return $res;
179			}
180			} else {
181
182			// If there was not an exact title match, look for title with missing chars
183			// example release name :Zorro 1990, tvrage name Zorro (1990)
184			// Only search if the title contains more than one word to prevent incorrect matches
185			$pieces = explode(' ', $title);
186			if (\count($pieces) > 1) {
187			$title2 = '%';
188			foreach ($pieces as $piece) {
189			$title2 .= str_replace(["'", '!'], '', $piece).'%';
190			}
191			$res = $this->getTitleLoose($title2, $type, $source);
192			if (isset($res)) {
193			return $res;
194			}
195			}
196			}
197
198			return false;
199			}
200
201			/**
202			* @param $title
203			* @param $type
204			* @param int $source
205			* @return bool\|\Illuminate\Database\Eloquent\Model\|null\|static
206			*/
207			public function getTitleExact($title, $type, $source = 0)
208			{
209			$return = false;
210			if (! empty($title)) {
211			$sql = Video::query()->where(['title' => $title, 'type' => $type]);
212			if ($source > 0) {
213			$sql->where('source', $source);
214			}
215			$query = $sql->first();
216			if (! empty($query)) {
217			$return = $query->value('id');
218			}
219			// Try for an alias
220			if (empty($return)) {
221			$sql = Video::query()
222			->join('videos_aliases', 'videos.id', '=', 'videos_aliases.videos_id')
223			->where(['videos_aliases.title' => $title, 'videos.type' => $type]);
224			if ($source > 0) {
225			$sql->where('videos.source', $source);
226			}
227			$query = $sql->first();
228			if (! empty($query)) {
229			$return = $query->value('videos.id');
230			}
231			}
232			}
233
234			return $return;
235			}
236
237			/**
238			* Supplementary function for getByTitle that queries for a like match.
239			*
240			* @param $title
241			* @param $type
242			* @param int $source
243			*
244			* @return array\|false
245			*/
246			public function getTitleLoose($title, $type, $source = 0)
247			{
248			$return = false;
249
250			if (! empty($title)) {
251			$sql = Video::query()
252			->where('title', 'like', rtrim($title, '%'))
253			->where('type', $type);
254			if ($source > 0) {
255			$sql->where('source', $source);
256			}
257			$return = $sql->first()->value('id');
258			// Try for an alias
259			if (empty($return)) {
260			$sql = Video::query()
261			->join('videos_aliases', 'videos.id', '=', 'videos_aliases.videos_id')
262			->where('videos_aliases.title', '=', rtrim($title, '%'))
263			->where('type', $type);
264			if ($source > 0) {
265			$sql->where('videos.source', $source);
266			}
267			$return = $sql->first()->value('videos.id');
268			}
269			}
270
271			return $return;
			0 ignored issues – show Bug Best Practice introduced 2019-11-22 19:47 UTC by Report Bug Copy Issue Report The expression `return $return` also could return the type `Illuminate\Database\Eloquent\Model` which is incompatible with the documented return type `array\|false`. Loading history...
272			}
273
274			/**
275			* Inserts aliases for videos.
276			*
277			* @param $videoId
278			* @param array $aliases
279			*/
280			public function addAliases($videoId, array $aliases = []): void
281			{
282			if (! empty($aliases) && $videoId > 0) {
283			foreach ($aliases as $key => $title) {
284			// Check for tvmaze style aka
285			if (\is_array($title) && ! empty($title['name'])) {
286			$title = $title['name'];
287			}
288			// Check if we have the AKA already
289			$check = $this->getAliases($videoId, $title);
290
291			if ($check === false) {
292			VideoAlias::insertOrIgnore(['videos_id' => $videoId, 'title' => $title, 'created_at' => now(), 'updated_at' => now()]);
293			}
294			}
295			}
296			}
297
298			/**
299			* Retrieves all aliases for given VideoID or VideoID for a given alias.
300			*
301			*
302			* @param int $videoId
303			* @param string $alias
304			* @return VideoAlias[]\|bool\|\Illuminate\Database\Eloquent\Builder[]\|\Illuminate\Database\Eloquent\Collection\|mixed
305			*/
306			public function getAliases(int $videoId, string $alias = '')
307			{
308			$return = false;
309			$expiresAt = now()->addMinutes(config('nntmux.cache_expiry_medium'));
310
311			if ($videoId > 0 \|\| $alias !== '') {
312			$aliasCache = Cache::get(md5($videoId.$alias));
313			if ($aliasCache !== null) {
314			$return = $aliasCache;
315			} else {
316			$sql = VideoAlias::query();
317			if ($videoId > 0) {
318			$sql->where('videos_id', $videoId);
319			} elseif ($alias !== '') {
320			$sql->where('title', $alias);
321			}
322			$return = $sql->get();
323			Cache::put(md5($videoId.$alias), $return, $expiresAt);
324			}
325			}
326
327			return $return->isEmpty() ? false : $return;
328			}
329			}
330

NNTmux / newznab-tmux

Push — dev ( e23b16...63cc84 )

Videos::getTitleExact() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like