Peertube
/
kodi.plugin.video.peertube
mirror of https://framagit.org/StCyr/plugin.video.peertube
1
0
Fork 0
Code Issues Releases Wiki Activity

Browse only local videos by default 

Use "local" instead of "all-local" by default because "all-local"
requires admin privileges

Other improvements:
* Replace urllib with requests to make the management of the HTTP
  requests simpler (better error handling and easier implementation of
  complex requests in the future)
* Refactor the functions used to build the HTTP request to improve
  maintainability (don't know if it makes sense to keep a single
  function for the "search" and the "list videos" request).
* Use "urlencode" to generate the Kodi URL using a dict to make it more
  generic.
* Create a function to log messages easily in Kodi's debug log. It will
  decrease the amount of duplicate code.
* Fix some errors reported by pylint with regards to PEP 8
This commit is contained in:
Thomas 2021-03-28 21:27:28 +00:00
parent 3677924a60
commit d657480eab
4 changed files with 203 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
addon.xml
View File

@ -3,6 +3,7 @@
<requires>
<import addon="xbmc.python" version="2.25.0"/>
<import addon="script.module.addon.signals" version="0.0.3"/>
<import addon="script.module.requests" version="2.22.0"/>
</requires>
<extension point="xbmc.python.pluginsource" library="peertube.py">
<provides>video</provides>

217
peertube.py
View File

@ -6,12 +6,24 @@
# - Handle languages better (with .po files)
# - Get the best quality torrent given settings and/or available bandwidth
# See how they do that in the peerTube client's code
import sys
import time, sys
import urllib2, json
try:
# Python 3.x
from urllib.parse import parse_qsl
except ImportError:
# Python 2.x
from urlparse import parse_qsl
import xbmc, xbmcgui, xbmcaddon, xbmcplugin, xbmcvfs
import AddonSignals
import requests
from requests.compat import urljoin, urlencode
import xbmc
import xbmcaddon
import xbmcgui
import xbmcplugin
import xbmcvfs
class PeertubeAddon():
"""
@ -25,15 +37,19 @@ class PeertubeAddon():
:return: None
"""
xbmc.log('PeertubeAddon: Initialising', xbmc.LOGDEBUG)
# These 2 steps must be done first since the logging function requires
# the add-on name
# Get an Addon instance
addon = xbmcaddon.Addon()
# Get the add-on name
self.addon_name = addon.getAddonInfo('name')
self.debug('Initialising')
# Save addon URL and ID
self.plugin_url = plugin
self.plugin_id = plugin_id
# Get an Addon instance
addon = xbmcaddon.Addon()
# Select preferred instance by default
self.selected_inst = addon.getSetting('preferred_instance')
@ -50,12 +66,24 @@ class PeertubeAddon():
self.play = 0
self.torrent_name = ''
# filter= 'local' or 'all-local' in verb search rest api
# applied for browsing only
self.video_filter = addon.getSetting('video_filter')
# Get the video filter from the settings that will be used when
# browsing the videos. The value from the settings is converted into
# one of the expected values by the REST APIs ("local" or "all-local")
if 'all-local' in addon.getSetting('video_filter'):
self.video_filter = 'all-local'
else:
self.video_filter = 'local'
return None
def debug(self, message):
"""Log a message in Kodi's log with the level xbmc.LOGDEBUG
:param message: Message to log
:type message: str
"""
xbmc.log('{0}: {1}'.format(self.addon_name, message), xbmc.LOGDEBUG)
def query_peertube(self, req):
"""
Issue a PeerTube API request and return the results
@ -64,20 +92,30 @@ class PeertubeAddon():
"""
# Send the PeerTube REST API request
self.debug('Issuing request {0}'.format(req))
response = requests.get(url=req)
data = response.json()
# Use Request.raise_for_status() to raise an exception if the HTTP
# request returned an unsuccessful status code.
try:
xbmc.log('PeertubeAddon: Issuing request {0}'.format(req), xbmc.LOGDEBUG)
resp = urllib2.urlopen(req)
data = json.load(resp)
except:
xbmcgui.Dialog().notification('Communication error', 'Error during my request on {0}'.format(self.selected_inst), xbmcgui.NOTIFICATION_ERROR)
return None
response.raise_for_status()
except requests.HTTPError as e:
xbmcgui.Dialog().notification('Communication error',
'Error during request on {0}'
.format(self.selected_inst),
xbmcgui.NOTIFICATION_ERROR)
# Print the JSON as it may contain an 'error' key with the details
# of the error
self.debug('Error => "{}"'.format(data['error']))
raise e
# Return when no results are found
if data['total'] == 0:
xbmc.log('PeertubeAddon: No result found', xbmc.LOGDEBUG)
self.debug('No result found')
return None
else:
xbmc.log('PeertubeAddon: Found {0} results'.format(data['total']), xbmc.LOGDEBUG)
self.debug('Found {0} results'.format(data['total']))
return data
@ -118,41 +156,48 @@ class PeertubeAddon():
# Videos are playable
list_item.setProperty('IsPlayable', 'true')
# Find the URL of the best possible video matching user's preferrence
# Find the URL of the best possible video matching user's preferences
# TODO: Error handling
current_res = 0
higher_res = -1
torrent_url = ''
resp = urllib2.urlopen(self.selected_inst + '/api/v1/videos/' + data['uuid'])
metadata = json.load(resp)
xbmc.log('PeertubeAddon: Looking for the best possible video matching user preferrences', xbmc.LOGDEBUG)
response = requests.get(self.selected_inst + '/api/v1/videos/'
+ data['uuid'])
metadata = response.json()
self.debug('Looking for the best possible video quality matching user preferences')
for f in metadata['files']:
# Get file resolution
res = f['resolution']['id']
if res == self.preferred_resolution:
# Stop directly, when we find the exact same resolution as the user's preferred one
xbmc.log('PeertubeAddon: Found video with preferred resolution', xbmc.LOGDEBUG)
self.debug('Found video with preferred resolution')
torrent_url = f['torrentUrl']
break
elif res < self.preferred_resolution and res > current_res:
# Else, try to find the best one just below the user's preferred one
xbmc.log('PeertubeAddon: Found video with good lower resolution ({0})'.format(f['resolution']['label']), xbmc.LOGDEBUG)
self.debug('Found video with good lower resolution'
'({0})'.format(f['resolution']['label']))
torrent_url = f['torrentUrl']
current_res = res
elif res > self.preferred_resolution and (res < higher_res or higher_res == -1):
# In the worth case, we'll take the one just above the user's preferred one
xbmc.log('PeertubeAddon: Saving video with higher resolution ({0}) as a possible alternative'.format(f['resolution']['label']), xbmc.LOGDEBUG)
# In the worst case, we'll take the one just above the user's preferred one
self.debug('Saving video with higher resolution ({0})'
'as a possible alternative'
.format(f['resolution']['label']))
backup_url = f['torrentUrl']
higher_res = res
# Use smallest file with an higher resolution, when we didn't find a resolution equal or
# slower than the user's preferred one
# lower than the user's preferred one
if not torrent_url:
xbmc.log('PeertubeAddon: Using video with higher resolution as alternative', xbmc.LOGDEBUG)
self.debug('Using video with higher resolution as alternative')
torrent_url = backup_url
# Compose the correct URL for Kodi
url = self.build_kodi_url_action_url('play_video', torrent_url)
url = self.build_kodi_url({
'action': 'play_video',
'url': torrent_url
})
elif data_type == 'instances':
# TODO: Add a context menu to select instance as preferred instance
@ -160,7 +205,10 @@ class PeertubeAddon():
list_item.setProperty('IsPlayable', 'false')
# Set URL to select this instance
url = self.build_kodi_url_action_url('select_instance',data['host'])
url = self.build_kodi_url({
'action': 'select_instance',
'url': data['host']
})
# Add our item to the listing as a 3-element tuple.
listing.append((url, list_item, False))
@ -168,21 +216,77 @@ class PeertubeAddon():
# Add a 'Next page' button when there are more data to show
start = int(start) + self.items_per_page
if lst['total'] > start:
list_item = xbmcgui.ListItem( label='Next page ({0})'.format(start/self.items_per_page) )
url = '{0}?action=browse_{1}&start={2}'.format(self.plugin_url, data_type, start)
list_item = xbmcgui.ListItem(label='Next page ({0})'
.format(start/self.items_per_page))
url = self.build_kodi_url({
'action': 'browse_{0}'.format(data_type),
'start': start})
listing.append((url, list_item, True))
return listing
def build_peertube_rest_api_search_request(self,search,start):
# Didn't yet find a correct way to do a search with a filter set to local.
# then if a search value is given it won't filter on local
def build_video_rest_api_request(self, search, start):
"""Build the URL of an HTTP request using the PeerTube videos REST API.
The same function is used for browsing and searching videos.
:param search: keywords to search
:type search: string
:param start: offset
:type start: int
:return: the URL of the request
:rtype: str
Didn't yet find a correct way to do a search with a filter set to
local. Then if a search value is given it won't filter on local
"""
# Common parameters of the request
params = {
'count': self.items_per_page,
'start': start,
'sort': self.sort_method
}
# Depending on the type of request (search or list videos), add
# specific parameters and define the API to use
if search is None:
# video api does not provide search=
req = '{0}/api/v1/videos?count={1}&start={2}&sort={3}&filter={4}'.format(self.selected_inst, self.items_per_page, start, self.sort_method,self.video_filter)
# Video API does not provide "search" but provides "filter" so add
# it to the parameters
params.update({'filter': self.video_filter})
api_url = '/api/v1/videos'
else:
# search api does not provide filter=
req = '{0}/api/v1/search/videos?count={1}&start={2}&sort={3}&search={4}'.format(self.selected_inst, self.items_per_page, start, self.sort_method,search)
# Search API does not provide "filter" but provides "search" so add
# it to the parameters
params.update({'search': search})
api_url = '/api/v1/search/videos'
# Build the full URL of the request (instance + API + parameters)
req = '{0}?{1}'.format(urljoin(self.selected_inst, api_url),
urlencode(params))
return req
def build_browse_instances_rest_api_request(self, start):
"""Build the URL of an HTTP request using the PeerTube REST API to
browse the PeerTube instances.
:param start: offset
:type start: int
:return: the URL of the request
:rtype: str
"""
# Create the parameters of the request
params = {
'count': self.items_per_page,
'start': start
}
# Join the base URL with the REST API and the parameters
req = '{0}?{1}'.format('https://instances.joinpeertube.org/api/v1/instances',
urlencode(params))
return req
def search_videos(self, start):
@ -200,7 +304,7 @@ class PeertubeAddon():
return None
# Create the PeerTube REST API request for searching videos
req = self.build_peertube_rest_api_search_request(search,start)
req = self.build_video_rest_api_request(search, start)
# Send the query
results = self.query_peertube(req)
@ -227,7 +331,7 @@ class PeertubeAddon():
"""
# Create the PeerTube REST API request for listing videos
req = self.build_peertube_rest_api_search_request(None,start)
req = self.build_video_rest_api_request(None, start)
# Send the query
results = self.query_peertube(req)
@ -249,7 +353,7 @@ class PeertubeAddon():
"""
# Create the PeerTube REST API request for browsing PeerTube instances
req = '{0}/api/v1/instances?count={1}&start={2}'.format('https://instances.joinpeertube.org', self.items_per_page, start)
req = self.build_browse_instances_rest_api_request(start)
# Send the query
results = self.query_peertube(req)
@ -271,7 +375,7 @@ class PeertubeAddon():
:return: None
"""
xbmc.log('PeertubeAddon: Received metadata_downloaded signal, will start playing media', xbmc.LOGDEBUG)
self.debug('Received metadata_downloaded signal, will start playing media')
self.play = 1
self.torrent_f = data['file']
@ -284,7 +388,7 @@ class PeertubeAddon():
:return: None
"""
xbmc.log('PeertubeAddon: Starting torrent download ({0})'.format(torrent_url), xbmc.LOGDEBUG)
self.debug('Starting torrent download ({0})'.format(torrent_url))
# Start a downloader thread
AddonSignals.sendSignal('start_download', {'url': torrent_url})
@ -305,7 +409,7 @@ class PeertubeAddon():
xbmc.sleep(3000)
# Pass the item to the Kodi player for actual playback.
xbmc.log('PeertubeAddon: Starting video playback ({0})'.format(torrent_url), xbmc.LOGDEBUG)
self.debug('Starting video playback ({0})'.format(torrent_url))
play_item = xbmcgui.ListItem(path=self.torrent_f)
xbmcplugin.setResolvedUrl(self.plugin_id, True, listitem=play_item)
@ -320,17 +424,19 @@ class PeertubeAddon():
self.selected_inst = 'https://' + instance
xbmcgui.Dialog().notification('Current instance changed', 'Changed current instance to {0}'.format(self.selected_inst), xbmcgui.NOTIFICATION_INFO)
xbmc.log('PeertubeAddon: Changing currently selected instance to {0}'.format(self.selected_inst), xbmc.LOGDEBUG)
self.debug('Changing currently selected instance to {0}'
.format(self.selected_inst))
return None
def build_kodi_url_action_url(self,action,url):
url = '{0}?action={1}&url={2}'.format(self.plugin_url,action,url)
return url
def build_kodi_url(self, parameters):
"""Build a Kodi URL based on the parameters.
def build_kodi_url_action(self,action):
url = '{0}?action={1}&start=0'.format(self.plugin_url,action)
return url
:param parameters: dict containing all the parameters that will be
encoded in the URL
"""
return '{0}?{1}'.format(self.plugin_url, urlencode(parameters))
def main_menu(self):
"""
@ -344,17 +450,17 @@ class PeertubeAddon():
# 1st menu entry
list_item = xbmcgui.ListItem(label='Browse selected instance')
url = self.build_kodi_url_action('browse_videos')
url = self.build_kodi_url({'action': 'browse_videos', 'start': 0})
listing.append((url, list_item, True))
# 2nd menu entry
list_item = xbmcgui.ListItem(label='Search on selected instance')
url = self.build_kodi_url_action('search_videos')
url = self.build_kodi_url({'action': 'search_videos', 'start': 0})
listing.append((url, list_item, True))
# 3rd menu entry
list_item = xbmcgui.ListItem(label='Select other instance')
url = self.build_kodi_url_action('browse_instances')
url = self.build_kodi_url({'action': 'browse_instances', 'start': 0})
listing.append((url, list_item, True))
# Add our listing to Kodi.
@ -400,6 +506,7 @@ class PeertubeAddon():
return None
if __name__ == '__main__':
# Initialise addon

2
resources/settings.xml
View File

@ -7,5 +7,5 @@
<setting id="preferred_resolution" type="select" values="1080|720|480|360|240" default='480' label="30003"/>
<setting type="sep"/>
<setting id="delete_files" type="bool" default="true" label="30004"/>
<setting id="video_filter" type="select" values="local|all-local" default="all-local" label="30005"/>
<setting id="video_filter" type="select" values="local|all-local (requires admin privileges)" default="local" label="30005"/>
</settings>