summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorvitiko98 <[email protected]>2022-06-29 00:07:18 -0400
committervitiko98 <[email protected]>2022-06-29 00:07:18 -0400
commitd2b40bd781a2b116e3cd32d4aded3d666b2105dd (patch)
tree7597e34fed0c8efd849d182f49e26b375b1c42af
parent5fab67bca0e43cc914bab667faf955a248fa41dd (diff)
downloadbazarr-1.0.5-beta.38.tar.gz
bazarr-1.0.5-beta.38.zip
Add Karagarga.in providerv1.0.5-beta.38
-rw-r--r--README.md1
-rw-r--r--bazarr/app/config.py6
-rw-r--r--bazarr/app/get_providers.py6
-rw-r--r--frontend/src/pages/Settings/Providers/list.ts25
-rw-r--r--libs/subliminal_patch/providers/karagarga.py237
-rw-r--r--tests/bazarr/app/test_get_providers.py8
-rw-r--r--tests/subliminal_patch/test_karagarga.py74
7 files changed, 357 insertions, 0 deletions
diff --git a/README.md b/README.md
index b84258701..9c7fccc73 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,7 @@ If you need something that is not already part of Bazarr, feel free to create a
- Hosszupuska
- LegendasDivx
- LegendasTV
+- Karagarga.in
- Ktuvit (Get `hashed_password` using method described [here](https://github.com/XBMCil/service.subtitles.ktuvit))
- Napiprojekt
- Napisy24
diff --git a/bazarr/app/config.py b/bazarr/app/config.py
index 8f001ed52..009c4235e 100644
--- a/bazarr/app/config.py
+++ b/bazarr/app/config.py
@@ -207,6 +207,12 @@ defaults = {
'hi_fallback': 'False',
'timeout': '600',
},
+ 'karagarga': {
+ 'username': '',
+ 'password': '',
+ 'f_username': '',
+ 'f_password': '',
+ },
'subsync': {
'use_subsync': 'False',
'use_subsync_threshold': 'False',
diff --git a/bazarr/app/get_providers.py b/bazarr/app/get_providers.py
index 7f29f697d..b7a517752 100644
--- a/bazarr/app/get_providers.py
+++ b/bazarr/app/get_providers.py
@@ -233,6 +233,12 @@ def get_providers_auth():
'ffmpeg_path': _FFMPEG_BINARY,
'timeout': settings.embeddedsubtitles.timeout,
},
+ 'karagarga': {
+ 'username': settings.karagarga.username,
+ 'password': settings.karagarga.password,
+ 'f_username': settings.karagarga.f_username,
+ 'f_password': settings.karagarga.f_password,
+ },
}
diff --git a/frontend/src/pages/Settings/Providers/list.ts b/frontend/src/pages/Settings/Providers/list.ts
index 069d70aeb..aa0aafe28 100644
--- a/frontend/src/pages/Settings/Providers/list.ts
+++ b/frontend/src/pages/Settings/Providers/list.ts
@@ -140,6 +140,31 @@ export const ProviderList: Readonly<ProviderInfo[]> = [
],
},
{
+ key: "karagarga",
+ name: "Karagarga.in",
+ description: "Movie Subtitles Provider (Private Tracker)",
+ inputs: [
+ {
+ type: "text",
+ key: "username",
+ },
+ {
+ type: "password",
+ key: "password",
+ },
+ {
+ type: "text",
+ key: "f_username",
+ name: "Forum username",
+ },
+ {
+ type: "password",
+ key: "f_password",
+ name: "Forum password",
+ },
+ ],
+ },
+ {
key: "ktuvit",
name: "Ktuvit",
description: "Hebrew Subtitles Provider",
diff --git a/libs/subliminal_patch/providers/karagarga.py b/libs/subliminal_patch/providers/karagarga.py
new file mode 100644
index 000000000..9e0705c0a
--- /dev/null
+++ b/libs/subliminal_patch/providers/karagarga.py
@@ -0,0 +1,237 @@
+# -*- coding: utf-8 -*-
+
+import datetime
+import logging
+
+from bs4 import BeautifulSoup as bso
+from requests import Session
+from subliminal.cache import region as cache_region
+from subliminal.exceptions import AuthenticationError
+from subliminal.exceptions import ConfigurationError
+from subliminal_patch.core import Movie
+from subliminal_patch.providers import Provider
+from subliminal_patch.providers.utils import update_matches
+from subliminal_patch.subtitle import Subtitle
+from subzero.language import Language
+
+logger = logging.getLogger(__name__)
+
+_PROVIDER_NAME = "karagarga"
+_BASE_URL = "https://karagarga.in"
+
+
+class KaragargaSubtitle(Subtitle):
+ provider_name = _PROVIDER_NAME
+ hash_verifiable = False
+
+ def __init__(self, language, page_link, release_info, downloads):
+ super().__init__(language, page_link=page_link)
+
+ self.release_info = release_info
+ self.downloads = downloads
+ self._matches = {"title", "year"}
+
+ def get_matches(self, video):
+ update_matches(self._matches, video, self.release_info, type="movie")
+
+ return self._matches
+
+ @property
+ def id(self):
+ return self.page_link
+
+
+_NO_LOGGED_IN_REDIRECT = 302
+_EXPIRATION_TIME = datetime.timedelta(weeks=1).total_seconds()
+
+
+class KaragargaProvider(Provider):
+ provider_name = _PROVIDER_NAME
+
+ # Only english for now
+ languages = {Language.fromietf("en")}
+
+ video_types = (Movie,)
+ subtitle_class = KaragargaSubtitle
+ _session: Session
+
+ def __init__(self, username: str, password: str, f_username=None, f_password=None):
+ if not username or not password:
+ raise ConfigurationError("Username/password not provided")
+
+ self._username = username
+ self._password = password
+ self._f_username = f_username or username
+ self._f_password = f_password or password
+
+ def initialize(self):
+ self._session = Session()
+ self._session.headers.update(
+ {"authority": "karagarga.in", "user-agent": "Bazarr"}
+ )
+ self._login()
+
+ def terminate(self):
+ self._session.close()
+
+ def _login(self):
+ self._login_main()
+ self._login_forum()
+
+ def _login_main(self):
+ data = {
+ "username": self._username,
+ "password": self._password,
+ }
+
+ self._session.post(f"{_BASE_URL}/takelogin.php", data=data)
+
+ if "pass" not in self._session.cookies:
+ raise AuthenticationError("Invalid username/password")
+
+ logger.debug("Karagarga login: OK")
+
+ def _login_forum(self):
+ params = {
+ "app": "core",
+ "module": "global",
+ "section": "login",
+ "do": "process",
+ }
+
+ data = {
+ # What's the origin of this key?
+ "auth_key": "880ea6a14ea49e853634fbdc5015a024",
+ #
+ "referer": "https://forum.karagarga.in/",
+ "ips_username": self._username,
+ "ips_password": self._password,
+ "rememberMe": "1",
+ "anonymous": "1",
+ }
+
+ self._session.post(
+ "https://forum.karagarga.in/index.php", params=params, data=data
+ )
+
+ if not {"session_id", "pass_hash"}.issubset(self._session.cookies.keys()):
+ raise AuthenticationError("Invalid forum username/password")
+
+ logger.debug("Karagarga forum login: OK")
+
+ @cache_region.cache_on_arguments(expiration_time=_EXPIRATION_TIME)
+ def _cached_get(self, url, params):
+ response = self._session.get(url, params=params)
+ if response.status_code == _NO_LOGGED_IN_REDIRECT:
+ raise AuthenticationError("Not logged in")
+
+ return response.content
+
+ def _search_movie(self, title, year):
+ params = {"search": title, "status": "completed"}
+ content = self._cached_get(f"{_BASE_URL}/pots.php", params)
+
+ soup = bso(content, "html.parser")
+
+ table = soup.find("table", {"cellspacing": "5"})
+
+ if table is None:
+ logger.debug("Failed to get table. Returning []")
+ return []
+
+ subtitles = []
+ scans = 0
+
+ for tr_ in table.find_all("tr"): # type: ignore
+ if "forum.karagarga" not in str(tr_):
+ continue
+
+ found_tds = tr_.find_all("td")
+ if len(found_tds) != 11:
+ continue
+
+ title = found_tds[1].text
+
+ if f"({year}" not in title:
+ logger.debug("Year doesn't match: %s", title)
+ continue
+
+ logger.debug("Movie matched: %s", title)
+
+ requested_language = found_tds[5].text
+ if "English" not in requested_language:
+ continue
+
+ forum_item = found_tds[9]
+
+ if "approved" not in str(forum_item):
+ logger.debug("Non-approved subtitle: %s", title)
+ continue
+
+ try:
+ forum_url = str(forum_item.find("a").get("href"))
+ except AttributeError:
+ continue
+
+ if scans > 2:
+ logger.debug("Forum scans limit exceeded")
+ break
+
+ subtitles += self._parse_from_forum(forum_url, Language.fromietf("en"))
+ scans += 1
+
+ return subtitles
+
+ def _parse_from_forum(self, url, language):
+ logger.debug("Scanning forum for subs: %s", url)
+
+ content = self._cached_get(url, {})
+
+ soup = bso(content, "html.parser")
+
+ for post in soup.find_all("div", {"class": "post entry-content"}):
+ yield from _gen_subtitles(post, language)
+
+ def list_subtitles(self, video, languages):
+ subtitles = self._search_movie(video.title, video.year)
+ if not subtitles:
+ return []
+
+ subtitles.sort(key=lambda x: x.downloads, reverse=True)
+ # Always return the most downloaded subtitle from the forum
+
+ return [subtitles[0]]
+
+ def download_subtitle(self, subtitle):
+ response = self._session.get(subtitle.page_link, allow_redirects=True)
+ response.raise_for_status()
+
+ subtitle.content = response.content
+
+
+def _gen_subtitles(post, language):
+ seen_urls = set()
+
+ for potential in post.select("p,li.attachment,div"):
+ downloads = potential.find("span", {"class": "desc lighter"})
+ if not downloads:
+ continue
+
+ try:
+ download_count = int(downloads.text.split()[0].strip())
+ item = [a_ for a_ in potential.find_all("a") if a_.find("strong")][0]
+ release_info = item.find("strong").text
+ except (AttributeError, KeyError, ValueError) as error:
+ logger.debug("Error parsing post: %s", error)
+ continue
+
+ url = item.get("href")
+
+ if not url or url in seen_urls:
+ continue
+
+ seen_urls.add(url)
+
+ subtitle = KaragargaSubtitle(language, url, release_info, download_count)
+ logger.debug("Valid subtitle found: %s - %s", release_info, subtitle)
+ yield subtitle
diff --git a/tests/bazarr/app/test_get_providers.py b/tests/bazarr/app/test_get_providers.py
index 20e1f1a62..3b28da186 100644
--- a/tests/bazarr/app/test_get_providers.py
+++ b/tests/bazarr/app/test_get_providers.py
@@ -34,3 +34,11 @@ def test_get_providers_auth_embeddedsubtitles():
assert isinstance(item["ffprobe_path"], str)
assert isinstance(item["ffmpeg_path"], str)
assert isinstance(item["timeout"], str)
+
+
+def test_get_providers_auth_karagarga():
+ item = get_providers.get_providers_auth()["karagarga"]
+ assert item["username"] is not None
+ assert item["password"] is not None
+ assert item["f_username"] is not None
+ assert item["f_password"] is not None
diff --git a/tests/subliminal_patch/test_karagarga.py b/tests/subliminal_patch/test_karagarga.py
new file mode 100644
index 000000000..c3790447b
--- /dev/null
+++ b/tests/subliminal_patch/test_karagarga.py
@@ -0,0 +1,74 @@
+import os
+import tempfile
+
+import pytest
+from subliminal.cache import region
+from subliminal_patch.providers.karagarga import ConfigurationError
+from subliminal_patch.providers.karagarga import KaragargaProvider
+from subliminal_patch.providers.karagarga import KaragargaSubtitle
+from subliminal_patch.providers.karagarga import Language
+
+_USER = os.environ.get("KARAGARGA_USER")
+_PASSWORD = os.environ.get("KARAGARGA_PASSWORD")
+
+# TODO: maybe move this region to subliminal_patch's conftest.py
+
+region.configure(
+ "dogpile.cache.dbm",
+ arguments={
+ "filename": os.path.join(tempfile.gettempdir(), "subliminal_patch_tests.db")
+ },
+)
+
+pytestmark = pytest.mark.skipif(
+ _USER is None or _PASSWORD is None,
+ reason="KARAGARGA_USER KARAGARGA_PASSWORD env vars not provided",
+)
+
+
[email protected](scope="module")
+def provider():
+ with KaragargaProvider(_USER, _PASSWORD) as provider:
+ yield provider
+
+
+def test_init_raises_configuration_error():
+ with pytest.raises(ConfigurationError):
+ assert KaragargaProvider("", "")
+
+
+def test_login(provider):
+ assert provider
+
+
+ "title,year,expected_subs_len",
+ [("Paradise", 2009, 2), ("Her Way", 2021, 2), ("Batrachian's Ballad", 2016, 1)],
+)
+def test_search_movie(provider, title, year, expected_subs_len):
+ subtitles = provider._search_movie(title, year)
+ assert len(subtitles) >= expected_subs_len
+
+
+def test_list_subtitles(provider, movies):
+ item = list(movies.values())[0]
+ item.title = "Paradise"
+ item.year = 2009
+
+ assert provider.list_subtitles(item, {Language.fromietf("en")})
+
+
+def test_download_subtitle(provider):
+ subtitle = KaragargaSubtitle(
+ Language.fromietf("en"),
+ "https://forum.karagarga.in/index.php?app=core&module=attach&section=attach&attach_id=49324",
+ "foo",
+ 1,
+ )
+ provider.download_subtitle(subtitle)
+ assert subtitle.is_valid()
+
+
+def test_subtitle_get_matches(movies):
+ subtitle = KaragargaSubtitle(Language.fromietf("en"), "foo", "Foo.2019", 0)
+ assert {"title", "year"}.issubset(subtitle.get_matches(movies["inexistent"]))