github/plexpy
1
0
Fork 0
mirror of https://github.com/Tautulli/Tautulli.git synced 2025-07-06 21:21:15 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add helper to cast API parameter true to bool

Browse source
This commit is contained in:
JonnyWong16 2020-02-22 22:33:49 -08:00
parent 37d09e9bad
commit 9edbe6af37
4 changed files with 29 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Tautulli.py
View file

@ -36,7 +36,7 @@ import time
import tzlocal import tzlocal
import plexpy import plexpy
from plexpy import config, database, logger, webstart from plexpy import config, database, helpers, logger, webstart
# Register signals, such as CTRL + C # Register signals, such as CTRL + C
@ -117,7 +117,7 @@ def main():
plexpy.SYS_UTC_OFFSET = datetime.datetime.now(plexpy.SYS_TIMEZONE).strftime('%z') plexpy.SYS_UTC_OFFSET = datetime.datetime.now(plexpy.SYS_TIMEZONE).strftime('%z')
if os.getenv('TAUTULLI_DOCKER', False) == 'True': if helpers.bool_true(os.getenv('TAUTULLI_DOCKER', False)):
plexpy.DOCKER = True plexpy.DOCKER = True
if args.dev: if args.dev:

2
plexpy/api2.py
View file

@ -116,7 +116,7 @@ class API2:
# Allow override for the api. # Allow override for the api.
self._api_out_type = kwargs.pop('out_type', 'json') self._api_out_type = kwargs.pop('out_type', 'json')
if 'app' in kwargs and kwargs.pop('app') == 'true': if 'app' in kwargs and helpers.bool_true(kwargs.pop('app')):
self._api_app = True self._api_app = True
if plexpy.CONFIG.API_ENABLED and not self._api_msg or self._api_cmd in ('get_apikey', 'docs', 'docs_md'): if plexpy.CONFIG.API_ENABLED and not self._api_msg or self._api_cmd in ('get_apikey', 'docs', 'docs_md'):

8
plexpy/helpers.py
View file

@ -1260,6 +1260,14 @@ def mask_config_passwords(config):
return config return config
def bool_true(value):
if value is True:
return True
elif isinstance(value, basestring) and value.lower() in ('1', 'true', 't', 'yes', 'y', 'on'):
return True
return False
def page(endpoint, *args, **kwargs): def page(endpoint, *args, **kwargs):
endpoints = { endpoints = {
'pms_image_proxy': pms_image_proxy, 'pms_image_proxy': pms_image_proxy,

36
plexpy/webserve.py
View file

@ -277,7 +277,7 @@ class WebInterface(object):
def return_plex_xml_url(self, endpoint='', plextv=False, **kwargs): def return_plex_xml_url(self, endpoint='', plextv=False, **kwargs):
kwargs['X-Plex-Token'] = plexpy.CONFIG.PMS_TOKEN kwargs['X-Plex-Token'] = plexpy.CONFIG.PMS_TOKEN
if plextv == 'true': if helpers.bool_true(plextv):
base_url = 'https://plex.tv' base_url = 'https://plex.tv'
else: else:
if plexpy.CONFIG.PMS_URL_OVERRIDE: if plexpy.CONFIG.PMS_URL_OVERRIDE:
@ -701,7 +701,7 @@ class WebInterface(object):
("play_count", True, False)] ("play_count", True, False)]
kwargs['json_data'] = build_datatables_json(kwargs, dt_columns, "sort_title") kwargs['json_data'] = build_datatables_json(kwargs, dt_columns, "sort_title")
if refresh == 'true': if helpers.bool_true(refresh):
refresh = True refresh = True
else: else:
refresh = False refresh = False
@ -3080,7 +3080,7 @@ class WebInterface(object):
def install_geoip_db(self, update=False, **kwargs): def install_geoip_db(self, update=False, **kwargs):
""" Downloads and installs the GeoLite2 database """ """ Downloads and installs the GeoLite2 database """
update = True if update == 'true' else False update = helpers.bool_true(update)
result = helpers.install_geoip_db(update=update) result = helpers.install_geoip_db(update=update)
@ -3486,7 +3486,7 @@ class WebInterface(object):
@cherrypy.tools.json_out() @cherrypy.tools.json_out()
@requireAuth(member_of("admin")) @requireAuth(member_of("admin"))
def verify_mobile_device(self, device_token='', cancel=False, **kwargs): def verify_mobile_device(self, device_token='', cancel=False, **kwargs):
if cancel == 'true': if helpers.bool_true(cancel):
mobile_app.TEMP_DEVICE_TOKEN = None mobile_app.TEMP_DEVICE_TOKEN = None
return {'result': 'error', 'message': 'Device registration cancelled.'} return {'result': 'error', 'message': 'Device registration cancelled.'}
@ -3651,7 +3651,7 @@ class WebInterface(object):
if not username and not password: if not username and not password:
return None return None
force = True if force == 'true' else False force = helpers.bool_true(force)
plex_tv = plextv.PlexTV(username=username, password=password) plex_tv = plextv.PlexTV(username=username, password=password)
token = plex_tv.get_plexpy_pms_token(force=force) token = plex_tv.get_plexpy_pms_token(force=force)
@ -3714,7 +3714,7 @@ class WebInterface(object):
result = {'identifier': identifier} result = {'identifier': identifier}
if identifier: if identifier:
if get_url == 'true': if helpers.bool_true(get_url):
server = self.get_server_resources(pms_ip=hostname, server = self.get_server_resources(pms_ip=hostname,
pms_port=port, pms_port=port,
pms_ssl=ssl, pms_ssl=ssl,
@ -3724,7 +3724,7 @@ class WebInterface(object):
result['url'] = server['pms_url'] result['url'] = server['pms_url']
result['ws'] = None result['ws'] = None
if test_websocket == 'true': if helpers.bool_true(test_websocket):
# Quick test websocket connection # Quick test websocket connection
ws_url = result['url'].replace('http', 'ws', 1) + '/:/websockets/notifications' ws_url = result['url'].replace('http', 'ws', 1) + '/:/websockets/notifications'
header = ['X-Plex-Token: %s' % plexpy.CONFIG.PMS_TOKEN] header = ['X-Plex-Token: %s' % plexpy.CONFIG.PMS_TOKEN]
@ -3778,7 +3778,7 @@ class WebInterface(object):
logger.info(u"New API key generated.") logger.info(u"New API key generated.")
logger._BLACKLIST_WORDS.add(apikey) logger._BLACKLIST_WORDS.add(apikey)
if device == 'true': if helpers.bool_true(device):
mobile_app.TEMP_DEVICE_TOKEN = apikey mobile_app.TEMP_DEVICE_TOKEN = apikey
return apikey return apikey
@ -3898,15 +3898,15 @@ class WebInterface(object):
@cherrypy.expose @cherrypy.expose
@requireAuth(member_of("admin")) @requireAuth(member_of("admin"))
def get_changelog(self, latest_only=False, since_prev_release=False, update_shown=False, **kwargs): def get_changelog(self, latest_only=False, since_prev_release=False, update_shown=False, **kwargs):
latest_only = (latest_only == 'true') latest_only = helpers.bool_true(latest_only)
since_prev_release = (since_prev_release == 'true') since_prev_release = helpers.bool_true(since_prev_release)
if since_prev_release and plexpy.PREV_RELEASE == common.RELEASE: if since_prev_release and plexpy.PREV_RELEASE == common.RELEASE:
latest_only = True latest_only = True
since_prev_release = False since_prev_release = False
# Set update changelog shown status # Set update changelog shown status
if update_shown == 'true': if helpers.bool_true(update_shown):
plexpy.CONFIG.__setattr__('UPDATE_SHOW_CHANGELOG', 0) plexpy.CONFIG.__setattr__('UPDATE_SHOW_CHANGELOG', 0)
plexpy.CONFIG.write() plexpy.CONFIG.write()
@ -4053,7 +4053,7 @@ class WebInterface(object):
background (str): 282828 background (str): 282828
blur (str): 3 blur (str): 3
img_format (str): png img_format (str): png
fallback (str): "poster", "cover", "art", "poster-live", "poster-art" fallback (str): "poster", "cover", "art", "poster-live", "art-live", "art-live-full"
refresh (bool): True or False whether to refresh the image cache refresh (bool): True or False whether to refresh the image cache
return_hash (bool): True or False to return the self-hosted image hash instead of the image return_hash (bool): True or False to return the self-hosted image hash instead of the image
@ -4069,7 +4069,7 @@ class WebInterface(object):
logger.warn('No image input received.') logger.warn('No image input received.')
return return
return_hash = (kwargs.get('return_hash') == 'true') return_hash = helpers.bool_true(kwargs.get('return_hash'))
if rating_key and not img: if rating_key and not img:
if fallback and fallback.startswith('art'): if fallback and fallback.startswith('art'):
@ -4099,7 +4099,7 @@ class WebInterface(object):
if not os.path.exists(c_dir): if not os.path.exists(c_dir):
os.mkdir(c_dir) os.mkdir(c_dir)
clip = True if clip == 'true' else False clip = helpers.bool_true(clip)
try: try:
if not plexpy.CONFIG.CACHE_IMAGES or refresh or 'indexes' in img: if not plexpy.CONFIG.CACHE_IMAGES or refresh or 'indexes' in img:
@ -4302,7 +4302,7 @@ class WebInterface(object):
``` ```
""" """
delete_all = (delete_all == 'true') delete_all = helpers.bool_true(delete_all)
data_factory = datafactory.DataFactory() data_factory = datafactory.DataFactory()
result = data_factory.delete_img_info(rating_key=rating_key, service=service, delete_all=delete_all) result = data_factory.delete_img_info(rating_key=rating_key, service=service, delete_all=delete_all)
@ -4415,7 +4415,7 @@ class WebInterface(object):
@requireAuth(member_of("admin")) @requireAuth(member_of("admin"))
def update_metadata(self, rating_key=None, query=None, update=False, **kwargs): def update_metadata(self, rating_key=None, query=None, update=False, **kwargs):
query_string = query query_string = query
update = True if update == 'True' else False update = helpers.bool_true(update)
data_factory = datafactory.DataFactory() data_factory = datafactory.DataFactory()
query = data_factory.get_search_query(rating_key=rating_key) query = data_factory.get_search_query(rating_key=rating_key)
@ -5882,8 +5882,8 @@ class WebInterface(object):
subject=newsletter['subject'], subject=newsletter['subject'],
body=newsletter['body'], body=newsletter['body'],
message=newsletter['message']) message=newsletter['message'])
preview = (preview == 'true') preview = helpers.bool_true(preview)
raw = (raw == 'true') raw = helpers.bool_true(raw)
if raw: if raw:
cherrypy.response.headers['Content-Type'] = 'application/json;charset=UTF-8' cherrypy.response.headers['Content-Type'] = 'application/json;charset=UTF-8'