503 lines
16 KiB
Python
503 lines
16 KiB
Python
# -*- coding: utf-8 -*-
|
|
from __future__ import division, absolute_import, print_function, unicode_literals
|
|
|
|
import json
|
|
|
|
import requests
|
|
|
|
from ..helper.exceptions import HTTPException
|
|
from ..helper.utils import settings
|
|
from ..helper import LazyLogger
|
|
|
|
|
|
LOG = LazyLogger(__name__)
|
|
|
|
|
|
def jellyfin_url(client, handler):
|
|
return "%s/%s" % (client.config.data["auth.server"], handler)
|
|
|
|
|
|
def basic_info():
|
|
return "Etag"
|
|
|
|
|
|
def info():
|
|
return (
|
|
"Path,Genres,SortName,Studios,Writer,Taglines,LocalTrailerCount,"
|
|
"OfficialRating,CumulativeRunTimeTicks,ItemCounts,"
|
|
"Metascore,AirTime,DateCreated,People,Overview,"
|
|
"Etag,ShortOverview,ProductionLocations,"
|
|
"Tags,ProviderIds,ParentId,RemoteTrailers,SpecialEpisodeNumbers,"
|
|
"MediaSources,VoteCount,RecursiveItemCount,PrimaryImageAspectRatio"
|
|
)
|
|
|
|
|
|
def music_info():
|
|
return (
|
|
"Etag,Genres,SortName,Studios,Writer,"
|
|
"OfficialRating,CumulativeRunTimeTicks,Metascore,"
|
|
"AirTime,DateCreated,MediaStreams,People,ProviderIds,Overview,ItemCounts"
|
|
)
|
|
|
|
|
|
class API(object):
|
|
"""All the api calls to the server."""
|
|
|
|
def __init__(self, client, *args, **kwargs):
|
|
self.client = client
|
|
self.config = client.config
|
|
self.default_timeout = 5
|
|
|
|
def _http(self, action, url, request=None):
|
|
if request is None:
|
|
request = {}
|
|
|
|
request.update({"type": action, "handler": url})
|
|
|
|
return self.client.request(request)
|
|
|
|
def _get(self, handler, params=None):
|
|
return self._http("GET", handler, {"params": params})
|
|
|
|
def _post(self, handler, json=None, params=None):
|
|
return self._http("POST", handler, {"params": params, "json": json})
|
|
|
|
def _delete(self, handler, params=None):
|
|
return self._http("DELETE", handler, {"params": params})
|
|
|
|
#################################################################################################
|
|
|
|
# Bigger section of the Jellyfin api
|
|
|
|
#################################################################################################
|
|
|
|
def try_server(self):
|
|
return self._get("System/Info/Public")
|
|
|
|
def sessions(self, handler="", action="GET", params=None, json=None):
|
|
if action == "POST":
|
|
return self._post("Sessions%s" % handler, json, params)
|
|
elif action == "DELETE":
|
|
return self._delete("Sessions%s" % handler, params)
|
|
else:
|
|
return self._get("Sessions%s" % handler, params)
|
|
|
|
def users(self, handler="", action="GET", params=None, json=None):
|
|
if action == "POST":
|
|
return self._post("Users/{UserId}%s" % handler, json, params)
|
|
elif action == "DELETE":
|
|
return self._delete("Users/{UserId}%s" % handler, params)
|
|
else:
|
|
return self._get("Users/{UserId}%s" % handler, params)
|
|
|
|
def items(self, handler="", action="GET", params=None, json=None):
|
|
if action == "POST":
|
|
return self._post("Items%s" % handler, json, params)
|
|
elif action == "DELETE":
|
|
return self._delete("Items%s" % handler, params)
|
|
else:
|
|
return self._get("Items%s" % handler, params)
|
|
|
|
def user_items(self, handler="", params=None):
|
|
return self.users("/Items%s" % handler, params=params)
|
|
|
|
def shows(self, handler, params):
|
|
return self._get("Shows%s" % handler, params)
|
|
|
|
def videos(self, handler):
|
|
return self._get("Videos%s" % handler)
|
|
|
|
def artwork(self, item_id, art, max_width, ext="jpg", index=None):
|
|
if index is None:
|
|
return jellyfin_url(
|
|
self.client,
|
|
"Items/%s/Images/%s?MaxWidth=%s&format=%s"
|
|
% (item_id, art, max_width, ext),
|
|
)
|
|
|
|
return jellyfin_url(
|
|
self.client,
|
|
"Items/%s/Images/%s/%s?MaxWidth=%s&format=%s"
|
|
% (item_id, art, index, max_width, ext),
|
|
)
|
|
|
|
#################################################################################################
|
|
|
|
# More granular api
|
|
|
|
#################################################################################################
|
|
|
|
def get_users(self):
|
|
return self._get("Users")
|
|
|
|
def get_public_users(self):
|
|
return self._get("Users/Public")
|
|
|
|
def get_user(self, user_id=None):
|
|
return self.users() if user_id is None else self._get("Users/%s" % user_id)
|
|
|
|
def get_views(self):
|
|
return self.users("/Views")
|
|
|
|
def get_media_folders(self):
|
|
return self.users("/Items")
|
|
|
|
def get_item(self, item_id):
|
|
return self.users("/Items/%s" % item_id)
|
|
|
|
def get_items(self, item_ids):
|
|
return self.users(
|
|
"/Items",
|
|
params={"Ids": ",".join(str(x) for x in item_ids), "Fields": info()},
|
|
)
|
|
|
|
def get_sessions(self):
|
|
return self.sessions(params={"ControllableByUserId": "{UserId}"})
|
|
|
|
def get_device(self, device_id):
|
|
return self.sessions(params={"DeviceId": device_id})
|
|
|
|
def post_session(self, session_id, url, params=None, data=None):
|
|
return self.sessions("/%s/%s" % (session_id, url), "POST", params, data)
|
|
|
|
def get_images(self, item_id):
|
|
return self.items("/%s/Images" % item_id)
|
|
|
|
def get_suggestion(self, media="Movie,Episode", limit=1):
|
|
return self.users("/Suggestions", params={"Type": media, "Limit": limit})
|
|
|
|
def get_recently_added(self, media=None, parent_id=None, limit=20):
|
|
return self.user_items(
|
|
"/Latest",
|
|
{
|
|
"Limit": limit,
|
|
"UserId": "{UserId}",
|
|
"IncludeItemTypes": media,
|
|
"ParentId": parent_id,
|
|
"Fields": info(),
|
|
},
|
|
)
|
|
|
|
def get_next(self, index=None, limit=1):
|
|
return self.shows(
|
|
"/NextUp",
|
|
{
|
|
"Limit": limit,
|
|
"UserId": "{UserId}",
|
|
"StartIndex": None if index is None else int(index),
|
|
},
|
|
)
|
|
|
|
def get_adjacent_episodes(self, show_id, item_id):
|
|
return self.shows(
|
|
"/%s/Episodes" % show_id,
|
|
{"UserId": "{UserId}", "AdjacentTo": item_id, "Fields": "Overview"},
|
|
)
|
|
|
|
def get_genres(self, parent_id=None):
|
|
return self._get(
|
|
"Genres", {"ParentId": parent_id, "UserId": "{UserId}", "Fields": info()}
|
|
)
|
|
|
|
def get_recommendation(self, parent_id=None, limit=20):
|
|
return self._get(
|
|
"Movies/Recommendations",
|
|
{
|
|
"ParentId": parent_id,
|
|
"UserId": "{UserId}",
|
|
"Fields": info(),
|
|
"Limit": limit,
|
|
},
|
|
)
|
|
|
|
def get_items_by_letter(self, parent_id=None, media=None, letter=None):
|
|
return self.user_items(
|
|
params={
|
|
"ParentId": parent_id,
|
|
"NameStartsWith": letter,
|
|
"Fields": info(),
|
|
"Recursive": True,
|
|
"IncludeItemTypes": media,
|
|
}
|
|
)
|
|
|
|
def get_channels(self):
|
|
return self._get(
|
|
"LiveTv/Channels",
|
|
{"UserId": "{UserId}", "EnableImages": True, "EnableUserData": True},
|
|
)
|
|
|
|
def get_intros(self, item_id):
|
|
return self.user_items("/%s/Intros" % item_id)
|
|
|
|
def get_additional_parts(self, item_id):
|
|
return self.videos("/%s/AdditionalParts" % item_id)
|
|
|
|
def delete_item(self, item_id):
|
|
return self.items("/%s" % item_id, "DELETE")
|
|
|
|
def get_local_trailers(self, item_id):
|
|
return self.user_items("/%s/LocalTrailers" % item_id)
|
|
|
|
def get_transcode_settings(self):
|
|
return self._get("System/Configuration/encoding")
|
|
|
|
def get_ancestors(self, item_id):
|
|
return self.items("/%s/Ancestors" % item_id, params={"UserId": "{UserId}"})
|
|
|
|
def get_items_theme_video(self, parent_id):
|
|
return self.users(
|
|
"/Items", params={"HasThemeVideo": True, "ParentId": parent_id}
|
|
)
|
|
|
|
def get_themes(self, item_id):
|
|
return self.items(
|
|
"/%s/ThemeMedia" % item_id,
|
|
params={"UserId": "{UserId}", "InheritFromParent": True},
|
|
)
|
|
|
|
def get_items_theme_song(self, parent_id):
|
|
return self.users(
|
|
"/Items", params={"HasThemeSong": True, "ParentId": parent_id}
|
|
)
|
|
|
|
def check_companion_enabled(self):
|
|
"""
|
|
True = Enabled
|
|
False = Not enabled
|
|
None = Unknown
|
|
"""
|
|
try:
|
|
plugin_settings = (
|
|
self._get("Jellyfin.Plugin.KodiSyncQueue/GetPluginSettings") or {}
|
|
)
|
|
return plugin_settings.get("IsEnabled")
|
|
|
|
except requests.RequestException as e:
|
|
LOG.warning("Error checking companion installed state: %s", e)
|
|
if e.response.status_code == 404:
|
|
return False
|
|
except HTTPException as e:
|
|
LOG.warning("Error checking companion installed state: %s", e)
|
|
if e.status == 404:
|
|
return False
|
|
|
|
return None
|
|
|
|
def get_seasons(self, show_id):
|
|
return self.shows(
|
|
"/%s/Seasons" % show_id,
|
|
params={"UserId": "{UserId}", "EnableImages": True, "Fields": info()},
|
|
)
|
|
|
|
def get_date_modified(self, date, parent_id, media=None):
|
|
return self.users(
|
|
"/Items",
|
|
params={
|
|
"ParentId": parent_id,
|
|
"Recursive": False,
|
|
"IsMissing": False,
|
|
"IsVirtualUnaired": False,
|
|
"IncludeItemTypes": media or None,
|
|
"MinDateLastSaved": date,
|
|
"Fields": info(),
|
|
},
|
|
)
|
|
|
|
def get_userdata_date_modified(self, date, parent_id, media=None):
|
|
return self.users(
|
|
"/Items",
|
|
params={
|
|
"ParentId": parent_id,
|
|
"Recursive": True,
|
|
"IsMissing": False,
|
|
"IsVirtualUnaired": False,
|
|
"IncludeItemTypes": media or None,
|
|
"MinDateLastSavedForUser": date,
|
|
"Fields": info(),
|
|
},
|
|
)
|
|
|
|
def refresh_item(self, item_id):
|
|
return self.items(
|
|
"/%s/Refresh" % item_id,
|
|
"POST",
|
|
json={
|
|
"Recursive": True,
|
|
"ImageRefreshMode": "FullRefresh",
|
|
"MetadataRefreshMode": "FullRefresh",
|
|
"ReplaceAllImages": False,
|
|
"ReplaceAllMetadata": True,
|
|
},
|
|
)
|
|
|
|
def favorite(self, item_id, option=True):
|
|
return self.users("/FavoriteItems/%s" % item_id, "POST" if option else "DELETE")
|
|
|
|
def get_system_info(self):
|
|
return self._get("System/Configuration")
|
|
|
|
def post_capabilities(self, data):
|
|
return self.sessions("/Capabilities/Full", "POST", json=data)
|
|
|
|
def session_add_user(self, session_id, user_id, option=True):
|
|
return self.sessions(
|
|
"/%s/User/%s" % (session_id, user_id), "POST" if option else "DELETE"
|
|
)
|
|
|
|
def session_playing(self, data):
|
|
return self.sessions("/Playing", "POST", json=data)
|
|
|
|
def session_progress(self, data):
|
|
return self.sessions("/Playing/Progress", "POST", json=data)
|
|
|
|
def session_stop(self, data):
|
|
return self.sessions("/Playing/Stopped", "POST", json=data)
|
|
|
|
def item_played(self, item_id, watched):
|
|
return self.users("/PlayedItems/%s" % item_id, "POST" if watched else "DELETE")
|
|
|
|
def get_sync_queue(self, date, filters=None):
|
|
return self._get(
|
|
"Jellyfin.Plugin.KodiSyncQueue/{UserId}/GetItems",
|
|
params={"LastUpdateDT": date, "filter": filters or "None"},
|
|
)
|
|
|
|
def get_server_time(self):
|
|
return self._get("Jellyfin.Plugin.KodiSyncQueue/GetServerDateTime")
|
|
|
|
def get_play_info(self, item_id, profile):
|
|
return self.items(
|
|
"/%s/PlaybackInfo" % item_id,
|
|
"POST",
|
|
json={
|
|
"UserId": "{UserId}",
|
|
"DeviceProfile": profile,
|
|
"AutoOpenLiveStream": True,
|
|
},
|
|
)
|
|
|
|
def get_live_stream(self, item_id, play_id, token, profile):
|
|
return self._post(
|
|
"LiveStreams/Open",
|
|
json={
|
|
"UserId": "{UserId}",
|
|
"DeviceProfile": profile,
|
|
"OpenToken": token,
|
|
"PlaySessionId": play_id,
|
|
"ItemId": item_id,
|
|
},
|
|
)
|
|
|
|
def close_live_stream(self, live_id):
|
|
return self._post("LiveStreams/Close", json={"LiveStreamId": live_id})
|
|
|
|
def close_transcode(self, device_id, play_id):
|
|
return self._delete(
|
|
"Videos/ActiveEncodings",
|
|
params={"DeviceId": device_id, "PlaySessionId": play_id},
|
|
)
|
|
|
|
def get_default_headers(self):
|
|
auth = "MediaBrowser "
|
|
auth += "Client=%s, " % self.config.data["app.name"]
|
|
auth += "Device=%s, " % self.config.data["app.device_name"]
|
|
auth += "DeviceId=%s, " % self.config.data["app.device_id"]
|
|
auth += "Version=%s" % self.config.data["app.version"]
|
|
|
|
return {
|
|
"Accept": "application/json",
|
|
"Content-type": "application/x-www-form-urlencoded; charset=UTF-8",
|
|
"X-Application": "%s/%s"
|
|
% (self.config.data["app.name"], self.config.data["app.version"]),
|
|
"Accept-Charset": "UTF-8,*",
|
|
"Accept-encoding": "gzip",
|
|
"User-Agent": self.config.data["http.user_agent"]
|
|
or "%s/%s"
|
|
% (self.config.data["app.name"], self.config.data["app.version"]),
|
|
"x-emby-authorization": auth,
|
|
}
|
|
|
|
def send_request(
|
|
self, url, path, method="get", timeout=None, headers=None, data=None
|
|
):
|
|
request_method = getattr(requests, method.lower())
|
|
url = "%s/%s" % (url, path)
|
|
request_settings = {
|
|
"timeout": timeout or self.default_timeout,
|
|
"headers": headers or self.get_default_headers(),
|
|
"data": data,
|
|
}
|
|
|
|
request_settings["verify"] = settings("sslverify.bool")
|
|
|
|
LOG.info("Sending %s request to %s" % (method, path))
|
|
LOG.debug(request_settings["timeout"])
|
|
LOG.debug(request_settings["headers"])
|
|
|
|
return request_method(url, **request_settings)
|
|
|
|
def login(self, server_url, username, password=""):
|
|
path = "Users/AuthenticateByName"
|
|
auth_data = {"username": username, "Pw": password}
|
|
|
|
headers = self.get_default_headers()
|
|
headers.update({"Content-type": "application/json"})
|
|
|
|
try:
|
|
LOG.info("Trying to login to %s/%s as %s" % (server_url, path, username))
|
|
response = self.send_request(
|
|
server_url,
|
|
path,
|
|
method="post",
|
|
timeout=10,
|
|
headers=headers,
|
|
data=json.dumps(auth_data),
|
|
)
|
|
|
|
if response.status_code == 200:
|
|
return response.json()
|
|
else:
|
|
LOG.error(
|
|
"Failed to login to server with status code: "
|
|
+ str(response.status_code)
|
|
)
|
|
LOG.error("Server Response:\n" + str(response.content))
|
|
LOG.debug(headers)
|
|
|
|
return {}
|
|
except (
|
|
Exception
|
|
) as e: # Find exceptions for likely cases i.e, server timeout, etc
|
|
LOG.error(e)
|
|
|
|
return {}
|
|
|
|
def validate_authentication_token(self, server):
|
|
auth_token_header = {"X-MediaBrowser-Token": server["AccessToken"]}
|
|
headers = self.get_default_headers()
|
|
headers.update(auth_token_header)
|
|
|
|
response = self.send_request(server["address"], "system/info", headers=headers)
|
|
|
|
if response.status_code == 200:
|
|
return response.json()
|
|
else:
|
|
return {"Status_Code": response.status_code}
|
|
|
|
def get_public_info(self, server_address):
|
|
response = self.send_request(server_address, "system/info/public")
|
|
try:
|
|
return response.json() if response.status_code == 200 else {}
|
|
except json.JSONDecodeError as e:
|
|
LOG.error("Failed to get server public info. JSON error: %s" % e)
|
|
LOG.error(response.content)
|
|
return {}
|
|
|
|
def check_redirect(self, server_address):
|
|
"""Checks if the server is redirecting traffic to a new URL and
|
|
returns the URL the server prefers to use
|
|
"""
|
|
response = self.send_request(server_address, "system/info/public")
|
|
return response.url.replace("/system/info/public", "")
|