Move files into app/http namespace

2026-09-01 02:38:55 +00:00 · 2023-01-22 20:45:02 +01:00
parent 3bd3eebcc5
commit 17a4183629
7 changed files with 7 additions and 7 deletions
@@ -0,0 +1,194 @@
+<?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    ruhllatio
+ * @copyright 2016 nZEDb
+ */
+
+namespace App\Http\Controllers\Api;
+
+use App\Models\AudioData;
+use App\Models\Category;
+use App\Models\Settings;
+use App\Models\UsenetGroup;
+use Blacklight\utility\Utility;
+
+/**
+ * Class API.
+ */
+class API extends Capabilities
+{
+    /**
+     * @var array The get request from the web server
+     */
+    public mixed $getRequest;
+
+    /**
+     * @param  array  $options
+     *
+     * @throws \Exception
+     */
+    public function __construct(array $options = [])
+    {
+        parent::__construct($options);
+        $defaults = [
+            'Settings' => null,
+            'Request'  => null,
+        ];
+        $options += $defaults;
+
+        $this->getRequest = $options['Request'];
+    }
+
+    /**
+     * Add language from media info XML to release search names (Used by API).
+     *
+     * @param  array  $releases
+     */
+    public function addLanguage(array &$releases): void
+    {
+        if ($releases && \count($releases)) {
+            foreach ($releases as $key => $release) {
+                if (isset($release->id)) {
+                    $language = AudioData::query()->where('releases_id', $release->id)->first(['audiolanguage']);
+                    if ($language !== null) {
+                        $release->searchname .= ' '.$language['audiolanguage'];
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Verify maxage parameter.
+     *
+     * @return int $maxAge The maximum age of the release
+     */
+    public function maxAge(): int
+    {
+        $maxAge = -1;
+        if (request()->has('maxage')) {
+            if (! request()->filled('maxage')) {
+                Utility::showApiError(201, 'Incorrect parameter (maxage must not be empty)');
+            } elseif (! is_numeric(request()->input('maxage'))) {
+                Utility::showApiError(201, 'Incorrect parameter (maxage must be numeric)');
+            } else {
+                $maxAge = (int) request()->input('maxage');
+            }
+        }
+
+        return $maxAge;
+    }
+
+    /**
+     * Verify cat parameter.
+     *
+     * @return array
+     */
+    public function categoryID(): array
+    {
+        $categoryID[] = -1;
+        if (request()->has('cat')) {
+            $categoryIDs = urldecode(request()->input('cat'));
+            // Append Web-DL category ID if HD present for SickBeard / Sonarr compatibility.
+            if (str_contains($categoryIDs, (string) Category::TV_HD) && ! str_contains($categoryIDs, (string) Category::TV_WEBDL) && (int) Settings::settingValue('indexer.categorise.catwebdl') === 0) {
+                $categoryIDs .= (','.Category::TV_WEBDL);
+            }
+            $categoryID = explode(',', $categoryIDs);
+        }
+
+        return $categoryID;
+    }
+
+    /**
+     * Verify groupName parameter.
+     *
+     * @return string|int|bool
+     *
+     * @throws \Exception
+     */
+    public function group(): string|int|bool
+    {
+        $groupName = -1;
+        if (request()->has('group')) {
+            $group = UsenetGroup::isValidGroup(request()->input('group'));
+            if ($group !== false) {
+                $groupName = $group;
+            }
+        }
+
+        return $groupName;
+    }
+
+    /**
+     * Verify limit parameter.
+     *
+     * @return int
+     */
+    public function limit(): int
+    {
+        $limit = 100;
+        if (request()->has('limit') && is_numeric(request()->input('limit'))) {
+            $limit = (int) request()->input('limit');
+        }
+
+        return $limit;
+    }
+
+    /**
+     * Verify offset parameter.
+     *
+     * @return int
+     */
+    public function offset(): int
+    {
+        $offset = 0;
+        if (request()->has('offset') && is_numeric(request()->input('offset'))) {
+            $offset = (int) request()->input('offset');
+        }
+
+        return $offset;
+    }
+
+    /**
+     * Check if a parameter is empty.
+     *
+     * @param  string  $parameter
+     */
+    public function verifyEmptyParameter(string $parameter): void
+    {
+        if (request()->has($parameter) && ! request()->filled($parameter)) {
+            Utility::showApiError(201, 'Incorrect parameter ('.$parameter.' must not be empty)');
+        }
+    }
+
+    /**
+     * @param $releases
+     * @param  callable  $getCoverURL
+     */
+    public function addCoverURL(&$releases, callable $getCoverURL): void
+    {
+        if ($releases && \count($releases)) {
+            foreach ($releases as $key => $release) {
+                if (isset($release->id)) {
+                    $release->coverurl = $getCoverURL($release);
+                }
+            }
+        }
+    }
+}