2022-05-12 19:10:03 +00:00
import glob , logging , os , re , requests , ruamel . yaml , signal , sys , time
2021-08-06 23:02:33 +00:00
from datetime import datetime , timedelta
2021-05-19 21:30:20 +00:00
from pathvalidate import is_valid_filename , sanitize_filename
2022-02-13 16:33:57 +00:00
from plexapi . audio import Album , Track
2021-05-11 01:22:18 +00:00
from plexapi . exceptions import BadRequest , NotFound , Unauthorized
2021-12-17 14:24:46 +00:00
from plexapi . video import Season , Episode , Movie
2022-05-15 20:29:54 +00:00
from PIL import Image , ImageColor , ImageDraw , ImageFont
2021-01-20 21:37:59 +00:00
try :
import msvcrt
windows = True
except ModuleNotFoundError :
windows = False
logger = logging . getLogger ( " Plex Meta Manager " )
class TimeoutExpired ( Exception ) :
pass
class Failed ( Exception ) :
pass
2022-05-28 16:01:51 +00:00
class Deleted ( Exception ) :
pass
2022-06-27 20:46:46 +00:00
class NonExisting ( Exception ) :
pass
2021-10-21 14:00:16 +00:00
class NotScheduled ( Exception ) :
pass
2022-01-06 19:16:12 +00:00
class NotScheduledRange ( NotScheduled ) :
pass
2021-06-30 15:02:55 +00:00
class ImageData :
2021-06-12 15:29:17 +00:00
def __init__ ( self , attribute , location , prefix = " " , is_poster = True , is_url = True ) :
self . attribute = attribute
self . location = location
self . prefix = prefix
self . is_poster = is_poster
self . is_url = is_url
self . compare = location if is_url else os . stat ( location ) . st_size
self . message = f " { prefix } { ' poster ' if is_poster else ' background ' } to [ { ' URL ' if is_url else ' File ' } ] { location } "
2021-10-04 17:51:32 +00:00
def __str__ ( self ) :
return str ( self . __dict__ )
2021-01-20 21:37:59 +00:00
def retry_if_not_failed ( exception ) :
return not isinstance ( exception , Failed )
2021-05-11 01:22:18 +00:00
def retry_if_not_plex ( exception ) :
return not isinstance ( exception , ( BadRequest , NotFound , Unauthorized ) )
2021-01-20 21:37:59 +00:00
days_alias = {
" monday " : 0 , " mon " : 0 , " m " : 0 ,
" tuesday " : 1 , " tues " : 1 , " tue " : 1 , " tu " : 1 , " t " : 1 ,
" wednesday " : 2 , " wed " : 2 , " w " : 2 ,
" thursday " : 3 , " thurs " : 3 , " thur " : 3 , " thu " : 3 , " th " : 3 , " r " : 3 ,
" friday " : 4 , " fri " : 4 , " f " : 4 ,
" saturday " : 5 , " sat " : 5 , " s " : 5 ,
" sunday " : 6 , " sun " : 6 , " su " : 6 , " u " : 6
}
2021-08-14 22:59:35 +00:00
mod_displays = {
2021-09-13 02:42:33 +00:00
" " : " is " , " .not " : " is not " , " .is " : " is " , " .isnot " : " is not " , " .begins " : " begins with " , " .ends " : " ends with " , " .before " : " is before " , " .after " : " is after " ,
2022-04-21 16:36:44 +00:00
" .gt " : " is greater than " , " .gte " : " is greater than or equal " , " .lt " : " is less than " , " .lte " : " is less than or equal " , " .regex " : " is "
2021-08-14 22:59:35 +00:00
}
2021-07-23 19:44:21 +00:00
pretty_days = { 0 : " Monday " , 1 : " Tuesday " , 2 : " Wednesday " , 3 : " Thursday " , 4 : " Friday " , 5 : " Saturday " , 6 : " Sunday " }
2021-01-20 21:37:59 +00:00
pretty_months = {
2021-07-23 19:44:21 +00:00
1 : " January " , 2 : " February " , 3 : " March " , 4 : " April " , 5 : " May " , 6 : " June " ,
7 : " July " , 8 : " August " , 9 : " September " , 10 : " October " , 11 : " November " , 12 : " December "
2021-01-20 21:37:59 +00:00
}
2022-03-03 14:43:00 +00:00
seasons = [ " current " , " winter " , " spring " , " summer " , " fall " ]
2021-07-23 19:44:21 +00:00
pretty_ids = { " anidbid " : " AniDB " , " imdbid " : " IMDb " , " mal_id " : " MyAnimeList " , " themoviedb_id " : " TMDb " , " thetvdb_id " : " TVDb " , " tvdbid " : " TVDb " }
2022-01-27 15:22:58 +00:00
advance_tags_to_edit = {
" Movie " : [ " metadata_language " , " use_original_title " ] ,
" Show " : [ " episode_sorting " , " keep_episodes " , " delete_episodes " , " season_display " , " episode_ordering " ,
" metadata_language " , " use_original_title " ] ,
" Artist " : [ " album_sorting " ]
}
tags_to_edit = {
" Movie " : [ " genre " , " label " , " collection " , " country " , " director " , " producer " , " writer " ] ,
2022-06-07 07:06:20 +00:00
" Video " : [ " genre " , " label " , " collection " , " country " , " director " , " producer " , " writer " ] ,
2022-01-27 15:22:58 +00:00
" Show " : [ " genre " , " label " , " collection " ] ,
2022-04-30 22:12:45 +00:00
" Artist " : [ " genre " , " label " , " style " , " mood " , " country " , " collection " , " similar_artist " ]
2022-01-27 15:22:58 +00:00
}
2022-02-06 07:33:09 +00:00
mdb_types = [ " mdb " , " mdb_imdb " , " mdb_metacritic " , " mdb_metacriticuser " , " mdb_trakt " , " mdb_tomatoes " , " mdb_tomatoesaudience " , " mdb_tmdb " , " mdb_letterboxd " ]
2022-04-13 04:30:59 +00:00
collection_mode_options = {
" default " : " default " , " hide " : " hide " ,
" hide_items " : " hideItems " , " hideitems " : " hideItems " ,
" show_items " : " showItems " , " showitems " : " showItems "
}
2022-04-23 19:57:33 +00:00
parental_types = [ " nudity " , " violence " , " profanity " , " alcohol " , " frightening " ]
parental_values = [ " None " , " Mild " , " Moderate " , " Severe " ]
parental_labels = [ f " { t . capitalize ( ) } : { v } " for t in parental_types for v in parental_values ]
2022-04-17 17:40:23 +00:00
github_base = " https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Configs/master/ "
2022-04-21 18:24:56 +00:00
previous_time = None
start_time = None
2022-06-27 06:15:54 +00:00
rating_mods = [ " 0 " , " % " , " # " ]
special_text_overlays = [ f " text( { a } { s } ) " for a in [ " audience_rating " , " critic_rating " , " user_rating " ] for s in [ " " ] + rating_mods ]
2021-01-20 21:37:59 +00:00
def make_ordinal ( n ) :
2021-07-26 20:29:28 +00:00
return f " { n } { ' th ' if 11 < = ( n % 100 ) < = 13 else [ ' th ' , ' st ' , ' nd ' , ' rd ' , ' th ' ] [ min ( n % 10 , 4 ) ] } "
2021-01-20 21:37:59 +00:00
2021-08-22 15:54:33 +00:00
def add_zero ( number ) :
return str ( number ) if len ( str ( number ) ) > 1 else f " 0 { number } "
2022-04-22 15:24:44 +00:00
def current_version ( version , nightly = False ) :
if nightly :
return get_version ( " nightly " )
elif version [ 2 ] > 0 :
new_version = get_version ( " develop " )
2022-05-05 12:48:04 +00:00
if version [ 1 ] != new_version [ 1 ] or new_version [ 2 ] > = version [ 2 ] :
return new_version
return get_version ( " nightly " )
2022-04-22 15:24:44 +00:00
else :
return get_version ( " master " )
def get_version ( level ) :
2022-03-18 13:00:42 +00:00
try :
2022-05-03 14:29:23 +00:00
url = f " https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/ { level } /VERSION "
2022-03-18 13:00:42 +00:00
return parse_version ( requests . get ( url ) . content . decode ( ) . strip ( ) )
except requests . exceptions . ConnectionError :
2022-05-03 14:29:23 +00:00
return " Unknown " , " Unknown " , 0
2022-03-18 13:00:42 +00:00
def parse_version ( version ) :
split_version = version . split ( " -develop " )
return version , split_version [ 0 ] , int ( split_version [ 1 ] ) if len ( split_version ) > 1 else 0
2022-05-10 13:25:35 +00:00
def download_image ( title , image_url , download_directory , filename ) :
response = requests . get ( image_url , headers = header ( ) )
if response . status_code > = 400 or " Content-Type " not in response . headers or response . headers [ " Content-Type " ] not in [ " image/png " , " image/jpeg " ] :
raise Failed ( f " Image Error: Failed to download Image URL: { image_url } " )
new_image = os . path . join ( download_directory , f " { filename } { ' .png ' if response . headers [ ' Content-Type ' ] == ' image/png ' else ' .jpg ' } " )
with open ( new_image , " wb " ) as handler :
handler . write ( response . content )
return ImageData ( " asset_directory " , new_image , prefix = f " { title } ' s " , is_url = False )
def get_image_dicts ( group , alias ) :
posters = { }
backgrounds = { }
for attr in [ " url_poster " , " file_poster " , " url_background " , " file_background " ] :
if attr in alias :
if group [ alias [ attr ] ] :
if " poster " in attr :
2022-05-20 20:35:11 +00:00
posters [ attr ] = group [ alias [ attr ] ]
2022-05-10 13:25:35 +00:00
else :
2022-05-20 20:35:11 +00:00
backgrounds [ attr ] = group [ alias [ attr ] ]
2022-05-10 13:25:35 +00:00
else :
logger . error ( f " Metadata Error: { attr } attribute is blank " )
return posters , backgrounds
def pick_image ( title , images , prioritize_assets , download_url_assets , item_dir , is_poster = True , image_name = None ) :
image_type = " poster " if is_poster else " background "
if image_name is None :
image_name = image_type
if images :
2022-05-20 20:35:11 +00:00
logger . debug ( f " { len ( images ) } { image_type } { ' s ' if len ( images ) > 1 else ' ' } found: " )
2022-05-10 13:25:35 +00:00
for i in images :
logger . debug ( f " Method: { i } { image_type . capitalize ( ) } : { images [ i ] } " )
is_url = True
final_attr = None
if prioritize_assets and " asset_directory " in images :
return images [ " asset_directory " ]
elif f " url_ { image_type } " in images :
if download_url_assets and item_dir :
if " asset_directory " in images :
return images [ " asset_directory " ]
else :
try :
return download_image ( title , images [ f " url_ { image_type } " ] , item_dir , image_name )
except Failed as e :
logger . error ( e )
final_attr = f " url_ { image_type } "
elif f " file_ { image_type } " in images :
final_attr = f " file_ { image_type } "
is_url = False
elif f " tmdb_ { image_type } " in images :
final_attr = f " tmdb_ { image_type } "
elif " tmdb_profile " in images :
final_attr = " tmdb_profile "
elif f " tvdb_ { image_type } " in images :
final_attr = f " tvdb_ { image_type } "
elif " asset_directory " in images :
return images [ " asset_directory " ]
elif " tmdb_person " in images :
final_attr = " tmdb_person "
elif " tmdb_collection_details " in images :
final_attr = " tmdb_collection_details "
elif " tmdb_actor_details " in images :
final_attr = " tmdb_actor_details "
elif " tmdb_crew_details " in images :
final_attr = " tmdb_crew_details "
elif " tmdb_director_details " in images :
final_attr = " tmdb_director_details "
elif " tmdb_producer_details " in images :
final_attr = " tmdb_producer_details "
elif " tmdb_writer_details " in images :
final_attr = " tmdb_writer_details "
elif " tmdb_movie_details " in images :
final_attr = " tmdb_movie_details "
elif " tvdb_movie_details " in images :
final_attr = " tvdb_movie_details "
elif " tvdb_show_details " in images :
final_attr = " tvdb_show_details "
elif " tmdb_show_details " in images :
final_attr = " tmdb_show_details "
if final_attr :
return ImageData ( final_attr , images [ final_attr ] , is_poster = is_poster , is_url = is_url )
2021-08-04 14:20:52 +00:00
def add_dict_list ( keys , value , dict_map ) :
for key in keys :
if key in dict_map :
dict_map [ key ] . append ( value )
else :
dict_map [ key ] = [ value ]
2022-05-09 15:22:41 +00:00
def get_list ( data , lower = False , upper = False , split = True , int_list = False , trim = True ) :
2022-05-05 12:48:04 +00:00
if split is True : split = " , "
2021-05-25 22:22:59 +00:00
if data is None : return None
2022-03-11 14:10:23 +00:00
elif isinstance ( data , list ) : list_data = data
2021-01-20 21:37:59 +00:00
elif isinstance ( data , dict ) : return [ data ]
2022-03-11 14:36:04 +00:00
elif split is False : list_data = [ str ( data ) ]
2022-05-22 17:26:54 +00:00
else : list_data = [ s . strip ( ) for s in str ( data ) . split ( split ) ]
2022-03-11 14:10:23 +00:00
2022-05-09 15:22:41 +00:00
def get_str ( input_data ) :
return str ( input_data ) . strip ( ) if trim else str ( input_data )
if lower is True : return [ get_str ( d ) . lower ( ) for d in list_data ]
elif upper is True : return [ get_str ( d ) . upper ( ) for d in list_data ]
2021-11-28 08:18:12 +00:00
elif int_list is True :
2022-05-09 15:22:41 +00:00
try : return [ int ( get_str ( d ) ) for d in list_data ]
2021-11-28 08:18:12 +00:00
except ValueError : return [ ]
2022-05-09 15:22:41 +00:00
else : return [ d if isinstance ( d , dict ) else get_str ( d ) for d in list_data ]
2021-01-20 21:37:59 +00:00
def get_int_list ( data , id_type ) :
int_values = [ ]
2021-07-30 19:19:43 +00:00
for value in get_list ( data ) :
2021-01-20 21:37:59 +00:00
try : int_values . append ( regex_first_int ( value , id_type ) )
except Failed as e : logger . error ( e )
return int_values
2021-07-21 19:25:29 +00:00
def validate_date ( date_text , method , return_as = None ) :
2022-03-23 07:45:26 +00:00
if isinstance ( date_text , datetime ) :
date_obg = date_text
else :
try :
date_obg = datetime . strptime ( str ( date_text ) , " % Y- % m- %d " if " - " in str ( date_text ) else " % m/ %d / % Y " )
except ValueError :
raise Failed ( f " Collection Error: { method } : { date_text } must match pattern YYYY-MM-DD (e.g. 2020-12-25) or MM/DD/YYYY (e.g. 12/25/2020) " )
2021-07-21 19:25:29 +00:00
return datetime . strftime ( date_obg , return_as ) if return_as else date_obg
2021-02-25 21:59:56 +00:00
2022-04-20 16:03:08 +00:00
def validate_regex ( data , col_type , validate = True ) :
regex_list = get_list ( data , split = False )
valid_regex = [ ]
for reg in regex_list :
try :
re . compile ( reg )
valid_regex . append ( reg )
except re . error :
err = f " { col_type } Error: Regular Expression Invalid: { reg } "
if validate :
raise Failed ( err )
else :
logger . error ( err )
return valid_regex
2021-01-20 21:37:59 +00:00
def logger_input ( prompt , timeout = 60 ) :
if windows : return windows_input ( prompt , timeout )
elif hasattr ( signal , " SIGALRM " ) : return unix_input ( prompt , timeout )
else : raise SystemError ( " Input Timeout not supported on this system " )
2021-07-14 14:47:20 +00:00
def header ( language = " en-US,en;q=0.5 " ) :
2022-05-23 18:42:27 +00:00
return { " Accept-Language " : " eng " if language == " default " else language , " User-Agent " : " Mozilla/5.0 " }
2021-07-14 14:47:20 +00:00
2021-01-20 21:37:59 +00:00
def alarm_handler ( signum , frame ) :
raise TimeoutExpired
def unix_input ( prompt , timeout = 60 ) :
2021-02-24 06:44:06 +00:00
prompt = f " | { prompt } : "
2021-01-20 21:37:59 +00:00
signal . signal ( signal . SIGALRM , alarm_handler )
signal . alarm ( timeout )
2021-07-04 04:13:06 +00:00
try : return input ( prompt )
except EOFError : raise Failed ( " Input Failed " )
finally : signal . alarm ( 0 )
2021-01-20 21:37:59 +00:00
def windows_input ( prompt , timeout = 5 ) :
2021-02-24 06:44:06 +00:00
sys . stdout . write ( f " | { prompt } : " )
2021-01-20 21:37:59 +00:00
sys . stdout . flush ( )
result = [ ]
start_time = time . time ( )
while True :
if msvcrt . kbhit ( ) :
2021-02-24 06:42:58 +00:00
char = msvcrt . getwche ( )
if ord ( char ) == 13 : # enter_key
2021-01-20 21:37:59 +00:00
out = " " . join ( result )
print ( " " )
2021-02-24 06:44:06 +00:00
logger . debug ( f " { prompt } : { out } " )
2021-01-20 21:37:59 +00:00
return out
2021-02-24 06:42:58 +00:00
elif ord ( char ) > = 32 : #space_char
result . append ( char )
2021-01-20 21:37:59 +00:00
if ( time . time ( ) - start_time ) > timeout :
print ( " " )
raise TimeoutExpired
def get_id_from_imdb_url ( imdb_url ) :
match = re . search ( " (tt \\ d+) " , str ( imdb_url ) )
if match : return match . group ( 1 )
2021-02-24 06:44:06 +00:00
else : raise Failed ( f " Regex Error: Failed to parse IMDb ID from IMDb URL: { imdb_url } " )
2021-01-20 21:37:59 +00:00
def regex_first_int ( data , id_type , default = None ) :
match = re . search ( " ( \\ d+) " , str ( data ) )
if match :
return int ( match . group ( 1 ) )
elif default :
2021-02-24 06:44:06 +00:00
logger . warning ( f " Regex Warning: Failed to parse { id_type } from { data } using { default } as default " )
2021-01-20 21:37:59 +00:00
return int ( default )
else :
2021-02-24 06:44:06 +00:00
raise Failed ( f " Regex Error: Failed to parse { id_type } from { data } " )
2021-01-20 21:37:59 +00:00
2021-05-19 21:30:20 +00:00
def validate_filename ( filename ) :
2022-05-31 15:22:51 +00:00
if is_valid_filename ( str ( filename ) ) :
2021-05-20 20:38:48 +00:00
return filename , None
2021-05-19 21:30:20 +00:00
else :
2022-05-31 15:22:51 +00:00
mapping_name = sanitize_filename ( str ( filename ) )
2021-05-20 20:38:48 +00:00
return mapping_name , f " Log Folder Name: { filename } is invalid using { mapping_name } "
2021-07-06 15:46:29 +00:00
2021-12-17 14:24:46 +00:00
def item_title ( item ) :
if isinstance ( item , Season ) :
if f " Season { item . index } " == item . title :
return f " { item . parentTitle } { item . title } "
else :
return f " { item . parentTitle } Season { item . index } : { item . title } "
elif isinstance ( item , Episode ) :
text = f " { item . grandparentTitle } S { add_zero ( item . parentIndex ) } E { add_zero ( item . index ) } "
if f " Season { item . parentIndex } " == item . parentTitle :
return f " { text } : { item . title } "
else :
return f " { text } : { item . parentTitle } : { item . title } "
elif isinstance ( item , Movie ) and item . year :
return f " { item . title } ( { item . year } ) "
2021-12-29 15:51:22 +00:00
elif isinstance ( item , Album ) :
return f " { item . parentTitle } : { item . title } "
elif isinstance ( item , Track ) :
return f " { item . grandparentTitle } : { item . parentTitle } : { item . title } "
2021-12-17 14:24:46 +00:00
else :
return item . title
2021-12-17 23:18:34 +00:00
def item_set ( item , item_id ) :
return { " title " : item_title ( item ) , " tmdb " if isinstance ( item , Movie ) else " tvdb " : item_id }
2021-07-06 15:46:29 +00:00
def is_locked ( filepath ) :
locked = None
file_object = None
if os . path . exists ( filepath ) :
try :
file_object = open ( filepath , ' a ' , 8 )
if file_object :
locked = False
2021-07-30 19:19:43 +00:00
except IOError :
2021-07-06 15:46:29 +00:00
locked = True
finally :
if file_object :
file_object . close ( )
return locked
2021-07-22 21:00:45 +00:00
2021-12-18 03:02:24 +00:00
def time_window ( tw ) :
2021-11-27 00:30:41 +00:00
today = datetime . now ( )
2021-12-18 03:02:24 +00:00
if tw == " today " :
2021-11-27 00:30:41 +00:00
return f " { today : %Y-%m-%d } "
2021-12-18 03:02:24 +00:00
elif tw == " yesterday " :
2021-11-27 00:30:41 +00:00
return f " { today - timedelta ( days = 1 ) : %Y-%m-%d } "
2021-12-18 03:02:24 +00:00
elif tw == " this_week " :
2021-11-27 00:30:41 +00:00
return f " { today : %Y-0%V } "
2021-12-18 03:02:24 +00:00
elif tw == " last_week " :
2021-11-27 00:30:41 +00:00
return f " { today - timedelta ( weeks = 1 ) : %Y-0%V } "
2021-12-18 03:02:24 +00:00
elif tw == " this_month " :
2021-11-27 00:30:41 +00:00
return f " { today : %Y-%m } "
2021-12-18 03:02:24 +00:00
elif tw == " last_month " :
2021-11-27 00:30:41 +00:00
return f " { today . year } - { today . month - 1 or 12 } "
2021-12-18 03:02:24 +00:00
elif tw == " this_year " :
2021-11-27 00:30:41 +00:00
return f " { today . year } "
2021-12-18 03:02:24 +00:00
elif tw == " last_year " :
2021-11-27 00:30:41 +00:00
return f " { today . year - 1 } "
else :
2021-12-18 03:02:24 +00:00
return tw
2021-11-27 00:30:41 +00:00
2022-06-01 04:50:38 +00:00
def load_files ( files_to_load , method , schedule = None , lib_vars = None ) :
2022-04-10 02:28:05 +00:00
files = [ ]
2022-06-01 04:50:38 +00:00
if not lib_vars :
lib_vars = { }
2022-04-18 18:16:39 +00:00
for file in get_list ( files_to_load , split = False ) :
if isinstance ( file , dict ) :
2022-04-10 02:28:05 +00:00
temp_vars = { }
2022-04-18 18:16:39 +00:00
if " template_variables " in file and file [ " template_variables " ] and isinstance ( file [ " template_variables " ] , dict ) :
temp_vars = file [ " template_variables " ]
2022-06-01 04:50:38 +00:00
for k , v in lib_vars . items ( ) :
if k not in temp_vars :
temp_vars [ k ] = v
2022-05-05 12:48:04 +00:00
asset_directory = [ ]
if " asset_directory " in file and file [ " asset_directory " ] :
for asset_path in get_list ( file [ " asset_directory " ] , split = False ) :
if os . path . exists ( asset_path ) :
asset_directory . append ( asset_path )
else :
logger . error ( f " Config Error: Asset Directory Does Not Exist: { asset_path } " )
2022-04-10 02:28:05 +00:00
2022-04-26 05:34:06 +00:00
current = [ ]
2022-04-10 02:28:05 +00:00
def check_dict ( attr , name ) :
2022-04-18 18:16:39 +00:00
if attr in file :
if file [ attr ] :
2022-04-26 05:34:06 +00:00
current . append ( ( name , file [ attr ] , temp_vars , asset_directory ) )
2022-04-10 02:28:05 +00:00
else :
2022-04-18 18:16:39 +00:00
logger . error ( f " Config Error: { method } { attr } is blank " )
2022-04-10 02:28:05 +00:00
check_dict ( " url " , " URL " )
check_dict ( " git " , " Git " )
check_dict ( " repo " , " Repo " )
check_dict ( " file " , " File " )
2022-04-18 18:16:39 +00:00
if " folder " in file :
if file [ " folder " ] is None :
logger . error ( f " Config Error: { method } folder is blank " )
elif not os . path . isdir ( file [ " folder " ] ) :
logger . error ( f " Config Error: Folder not found: { file [ ' folder ' ] } " )
2022-04-10 02:28:05 +00:00
else :
2022-04-27 15:11:10 +00:00
yml_files = glob_filter ( os . path . join ( file [ " folder " ] , f " *.yml " ) )
2022-04-10 02:28:05 +00:00
if yml_files :
2022-04-26 05:34:06 +00:00
current . extend ( [ ( " File " , yml , temp_vars , asset_directory ) for yml in yml_files ] )
2022-04-10 02:28:05 +00:00
else :
2022-04-27 15:11:10 +00:00
logger . error ( f " Config Error: No YAML (.yml) files found in { file [ ' folder ' ] } " )
2022-04-26 05:34:06 +00:00
if schedule and " schedule " in file and file [ " schedule " ] :
current_time , run_hour , ignore_schedules = schedule
logger . debug ( f " Value: { file [ ' schedule ' ] } " )
err = None
try :
schedule_check ( " schedule " , file [ " schedule " ] , current_time , run_hour )
except NotScheduledRange as e :
err = e
except NotScheduled as e :
if not ignore_schedules :
err = e
if err :
logger . warning ( f " { err } \n \n Metadata File { ' s ' if len ( current ) > 1 else ' ' } not scheduled to run " )
for file_type , file_path , temp_vars , asset_directory in current :
logger . warning ( f " { file_type } : { file_path } " )
continue
files . extend ( current )
2022-04-10 02:28:05 +00:00
else :
2022-04-18 18:16:39 +00:00
if os . path . exists ( file ) :
2022-04-21 05:35:07 +00:00
files . append ( ( " File " , file , { } , None ) )
2022-04-10 02:28:05 +00:00
else :
2022-04-18 18:16:39 +00:00
logger . error ( f " Config Error: Path not found: { file } " )
2022-04-10 02:28:05 +00:00
return files
2022-02-06 07:33:09 +00:00
def check_num ( num , is_int = True ) :
try :
return int ( str ( num ) ) if is_int else float ( str ( num ) )
except ( ValueError , TypeError ) :
return None
2022-04-13 04:30:59 +00:00
def check_collection_mode ( collection_mode ) :
if collection_mode and str ( collection_mode ) . lower ( ) in collection_mode_options :
return collection_mode_options [ str ( collection_mode ) . lower ( ) ]
else :
raise Failed ( f " Config Error: { collection_mode } collection_mode invalid \n \t default (Library default) \n \t hide (Hide Collection) \n \t hide_items (Hide Items in this Collection) \n \t show_items (Show this Collection and its Items) " )
2021-08-10 15:33:32 +00:00
def glob_filter ( filter_in ) :
filter_in = filter_in . translate ( { ord ( " [ " ) : " [[] " , ord ( " ] " ) : " []] " } ) if " [ " in filter_in else filter_in
2021-12-13 07:30:19 +00:00
return glob . glob ( filter_in )
2021-08-10 15:33:32 +00:00
2021-08-07 06:01:21 +00:00
def is_date_filter ( value , modifier , data , final , current_time ) :
if value is None :
return True
2021-08-06 23:02:33 +00:00
if modifier in [ " " , " .not " ] :
threshold_date = current_time - timedelta ( days = data )
2021-08-07 06:01:21 +00:00
if ( modifier == " " and ( value is None or value < threshold_date ) ) \
or ( modifier == " .not " and value and value > = threshold_date ) :
return True
2021-08-06 23:02:33 +00:00
elif modifier in [ " .before " , " .after " ] :
filter_date = validate_date ( data , final )
2021-08-07 06:01:21 +00:00
if ( modifier == " .before " and value > = filter_date ) or ( modifier == " .after " and value < = filter_date ) :
return True
2021-08-06 23:02:33 +00:00
elif modifier == " .regex " :
2021-08-07 06:01:21 +00:00
jailbreak = True
2021-08-06 23:02:33 +00:00
for check_data in data :
2021-08-07 06:01:21 +00:00
if re . compile ( check_data ) . match ( value . strftime ( " % m/ %d / % Y " ) ) :
2021-08-06 23:02:33 +00:00
jailbreak = True
break
if not jailbreak :
2021-08-07 06:01:21 +00:00
return True
return False
def is_number_filter ( value , modifier , data ) :
2022-06-16 03:20:40 +00:00
return value is None or ( modifier == " " and value == data ) \
or ( modifier == " .not " and value != data ) \
or ( modifier == " .gt " and value < = data ) \
2021-08-07 06:01:21 +00:00
or ( modifier == " .gte " and value < data ) \
or ( modifier == " .lt " and value > = data ) \
or ( modifier == " .lte " and value > data )
2021-12-10 16:17:50 +00:00
def is_boolean_filter ( value , data ) :
return ( data and not value ) or ( not data and value )
2021-08-07 06:01:21 +00:00
def is_string_filter ( values , modifier , data ) :
jailbreak = False
for value in values :
for check_value in data :
if ( modifier in [ " " , " .not " ] and check_value . lower ( ) in value . lower ( ) ) \
2021-09-13 02:42:33 +00:00
or ( modifier in [ " .is " , " .isnot " ] and value . lower ( ) == check_value . lower ( ) ) \
2021-08-07 06:01:21 +00:00
or ( modifier == " .begins " and value . lower ( ) . startswith ( check_value . lower ( ) ) ) \
or ( modifier == " .ends " and value . lower ( ) . endswith ( check_value . lower ( ) ) ) \
2022-04-13 04:30:59 +00:00
or ( modifier == " .regex " and re . compile ( check_value ) . search ( value ) ) :
2021-08-07 06:01:21 +00:00
jailbreak = True
break
if jailbreak : break
2021-09-13 02:42:33 +00:00
return ( jailbreak and modifier in [ " .not " , " .isnot " ] ) or ( not jailbreak and modifier in [ " " , " .is " , " .begins " , " .ends " , " .regex " ] )
2021-08-06 23:02:33 +00:00
2021-12-19 04:11:23 +00:00
def check_day ( _m , _d ) :
if _m in [ 1 , 3 , 5 , 7 , 8 , 10 , 12 ] and _d > 31 :
return _m , 31
elif _m in [ 4 , 6 , 9 , 11 ] and _d > 30 :
return _m , 30
elif _m == 2 and _d > 28 :
return _m , 28
else :
return _m , _d
2022-05-12 14:09:08 +00:00
def schedule_check ( attribute , data , current_time , run_hour , is_all = False ) :
2022-01-06 19:16:12 +00:00
range_collection = False
2022-06-27 20:46:46 +00:00
non_existing = False
2022-04-30 22:25:29 +00:00
all_check = 0
schedules_run = 0
2021-12-18 03:02:24 +00:00
next_month = current_time . replace ( day = 28 ) + timedelta ( days = 4 )
last_day = next_month - timedelta ( days = next_month . day )
schedule_str = " "
2022-05-12 14:09:08 +00:00
if isinstance ( data , str ) and ( ( " all " in data and not data . endswith ( " ] " ) ) or data . count ( " all " ) > 1 ) :
raise Failed ( " Schedule Error: each all schedule must be on its own line " )
elif isinstance ( data , str ) and " all " in data :
data = [ data ]
2022-04-30 22:25:29 +00:00
for schedule in get_list ( data ) :
2021-12-18 03:02:24 +00:00
run_time = str ( schedule ) . lower ( )
2022-01-06 19:16:12 +00:00
display = f " { attribute } attribute { schedule } invalid "
2022-04-30 22:25:29 +00:00
schedules_run + = 1
2022-05-12 14:09:08 +00:00
if run_time . startswith ( " all " ) :
match = re . search ( " \\ [([^ \\ ]]+) \\ ] " , run_time )
if not match :
logger . error ( f " Schedule Error: failed to parse { attribute } : { schedule } " )
continue
try :
2022-05-12 15:04:52 +00:00
schedule_str + = f " \n Scheduled to meet all of these: \n \t "
schedule_str + = schedule_check ( attribute , match . group ( 1 ) , current_time , run_hour , is_all = True )
2022-05-12 14:09:08 +00:00
all_check + = 1
2022-05-12 15:04:52 +00:00
except NotScheduled as e :
schedule_str + = str ( e )
2022-05-12 14:09:08 +00:00
continue
2022-04-30 22:25:29 +00:00
elif run_time . startswith ( ( " day " , " daily " ) ) :
all_check + = 1
2022-06-27 20:46:46 +00:00
elif run_time . startswith ( " non_existing " ) :
all_check + = 1
non_existing = True
2021-12-18 03:02:24 +00:00
elif run_time == " never " :
schedule_str + = f " \n Never scheduled to run "
elif run_time . startswith ( ( " hour " , " week " , " month " , " year " , " range " ) ) :
match = re . search ( " \\ (([^)]+) \\ ) " , run_time )
if not match :
2021-12-19 05:41:58 +00:00
logger . error ( f " Schedule Error: failed to parse { attribute } : { schedule } " )
2021-12-18 03:02:24 +00:00
continue
param = match . group ( 1 )
if run_time . startswith ( " hour " ) :
try :
if 0 < = int ( param ) < = 23 :
2022-05-12 15:04:52 +00:00
schedule_str + = f " \n Scheduled to run on the { make_ordinal ( int ( param ) ) } hour "
2021-12-18 03:02:24 +00:00
if run_hour == int ( param ) :
2022-04-30 22:25:29 +00:00
all_check + = 1
2021-12-18 03:02:24 +00:00
else :
raise ValueError
except ValueError :
2022-01-06 19:16:12 +00:00
logger . error ( f " Schedule Error: hourly { display } must be an integer between 0 and 23 " )
2021-12-18 03:02:24 +00:00
elif run_time . startswith ( " week " ) :
if param . lower ( ) not in days_alias :
2022-01-06 19:16:12 +00:00
logger . error ( f " Schedule Error: weekly { display } must be a day of the week i.e. weekly(Monday) " )
2021-12-18 03:02:24 +00:00
continue
weekday = days_alias [ param . lower ( ) ]
schedule_str + = f " \n Scheduled weekly on { pretty_days [ weekday ] } "
if weekday == current_time . weekday ( ) :
2022-04-30 22:25:29 +00:00
all_check + = 1
2021-12-18 03:02:24 +00:00
elif run_time . startswith ( " month " ) :
try :
if 1 < = int ( param ) < = 31 :
schedule_str + = f " \n Scheduled monthly on the { make_ordinal ( int ( param ) ) } "
if current_time . day == int ( param ) or (
current_time . day == last_day . day and int ( param ) > last_day . day ) :
2022-04-30 22:25:29 +00:00
all_check + = 1
2021-12-18 03:02:24 +00:00
else :
raise ValueError
except ValueError :
2022-01-06 19:16:12 +00:00
logger . error ( f " Schedule Error: monthly { display } must be an integer between 1 and 31 " )
2021-12-18 03:02:24 +00:00
elif run_time . startswith ( " year " ) :
try :
if " / " in param :
opt = param . split ( " / " )
month = int ( opt [ 0 ] )
day = int ( opt [ 1 ] )
schedule_str + = f " \n Scheduled yearly on { pretty_months [ month ] } { make_ordinal ( day ) } "
if current_time . month == month and ( current_time . day == day or (
current_time . day == last_day . day and day > last_day . day ) ) :
2022-04-30 22:25:29 +00:00
all_check + = 1
2021-12-18 03:02:24 +00:00
else :
raise ValueError
except ValueError :
2022-01-06 19:16:12 +00:00
logger . error ( f " Schedule Error: yearly { display } must be in the MM/DD format i.e. yearly(11/22) " )
2021-12-18 03:02:24 +00:00
elif run_time . startswith ( " range " ) :
match = re . match ( " ^(1[0-2]|0?[1-9])/(3[01]|[12][0-9]|0?[1-9])-(1[0-2]|0?[1-9])/(3[01]|[12][0-9]|0?[1-9])$ " , param )
if not match :
2022-01-06 19:16:12 +00:00
logger . error ( f " Schedule Error: range { display } must be in the MM/DD-MM/DD format i.e. range(12/01-12/25) " )
2021-12-18 03:02:24 +00:00
continue
month_start , day_start = check_day ( int ( match . group ( 1 ) ) , int ( match . group ( 2 ) ) )
month_end , day_end = check_day ( int ( match . group ( 3 ) ) , int ( match . group ( 4 ) ) )
month_check , day_check = check_day ( current_time . month , current_time . day )
check = datetime . strptime ( f " { month_check } / { day_check } " , " % m/ %d " )
start = datetime . strptime ( f " { month_start } / { day_start } " , " % m/ %d " )
end = datetime . strptime ( f " { month_end } / { day_end } " , " % m/ %d " )
2022-01-06 19:16:12 +00:00
range_collection = True
2021-12-18 03:02:24 +00:00
schedule_str + = f " \n Scheduled between { pretty_months [ month_start ] } { make_ordinal ( day_start ) } and { pretty_months [ month_end ] } { make_ordinal ( day_end ) } "
2021-12-19 04:11:23 +00:00
if start < = check < = end if start < end else ( check < = end or check > = start ) :
2022-04-30 22:25:29 +00:00
all_check + = 1
2021-12-18 03:02:24 +00:00
else :
2022-01-06 19:16:12 +00:00
logger . error ( f " Schedule Error: { display } " )
2022-05-12 15:04:52 +00:00
if is_all :
schedule_str . replace ( " \n " , " \n \t " )
2022-05-12 14:09:08 +00:00
if ( all_check == 0 and not is_all ) or ( is_all and schedules_run != all_check ) :
2022-06-27 20:46:46 +00:00
if non_existing :
raise NonExisting ( schedule_str )
elif range_collection :
2022-04-30 22:25:29 +00:00
raise NotScheduledRange ( schedule_str )
else :
raise NotScheduled ( schedule_str )
2022-05-12 15:04:52 +00:00
return schedule_str
2022-01-28 18:36:21 +00:00
2022-03-28 16:15:34 +00:00
def check_int ( value , datatype = " int " , minimum = 1 , maximum = None ) :
try :
value = int ( str ( value ) ) if datatype == " int " else float ( str ( value ) )
if ( maximum is None and minimum < = value ) or ( maximum is not None and minimum < = value < = maximum ) :
return value
except ValueError :
pass
def parse ( error , attribute , data , datatype = None , methods = None , parent = None , default = None , options = None , translation = None , minimum = 1 , maximum = None , regex = None , range_split = None ) :
2022-01-28 18:36:21 +00:00
display = f " { parent + ' ' if parent else ' ' } { attribute } attribute "
if options is None and translation is not None :
options = [ o for o in translation ]
value = data [ methods [ attribute ] ] if methods and attribute in methods else data
2022-03-25 20:13:51 +00:00
if datatype in [ " list " , " commalist " , " strlist " ] :
2022-01-28 21:20:09 +00:00
final_list = [ ]
2022-01-28 18:36:21 +00:00
if value :
2022-04-14 13:29:54 +00:00
if datatype in [ " commalist " , " strlist " ] and isinstance ( value , dict ) :
raise Failed ( f " { error } Error: { display } { value } must be a list or string " )
2022-01-28 18:36:21 +00:00
if datatype == " commalist " :
value = get_list ( value )
2022-01-28 21:20:09 +00:00
if not isinstance ( value , list ) :
value = [ value ]
for v in value :
if v :
2022-03-25 20:13:51 +00:00
if options is None or ( options and ( v in options or ( datatype == " strlist " and str ( v ) in options ) ) ) :
final_list . append ( str ( v ) if datatype == " strlist " else v )
2022-01-28 21:20:09 +00:00
elif options :
2022-04-14 13:29:54 +00:00
raise Failed ( f " { error } Error: { display } { v } is invalid; Options include: { ' , ' . join ( options ) } " )
2022-01-28 21:20:09 +00:00
return final_list
2022-01-28 18:36:21 +00:00
elif datatype == " intlist " :
if value :
try :
return [ int ( v ) for v in value if v ] if isinstance ( value , list ) else [ int ( value ) ]
except ValueError :
pass
return [ ]
2022-01-30 07:48:56 +00:00
elif datatype == " listdict " :
2022-01-28 18:36:21 +00:00
final_list = [ ]
for dict_data in get_list ( value ) :
if isinstance ( dict_data , dict ) :
2022-02-13 22:47:08 +00:00
final_list . append ( dict_data )
2022-01-28 18:36:21 +00:00
else :
raise Failed ( f " { error } Error: { display } { dict_data } is not a dictionary " )
return final_list
2022-03-19 16:02:52 +00:00
elif datatype in [ " dict " , " dictlist " , " dictdict " , " strdict " , " dictliststr " ] :
2022-01-28 18:36:21 +00:00
if isinstance ( value , dict ) :
2022-01-30 07:48:56 +00:00
if datatype == " dict " :
return value
elif datatype == " dictlist " :
return { k : v if isinstance ( v , list ) else [ v ] for k , v in value . items ( ) }
2022-03-19 16:02:52 +00:00
elif datatype == " dictliststr " :
return { str ( k ) : [ str ( y ) for y in v ] if isinstance ( v , list ) else [ str ( v ) ] for k , v in value . items ( ) }
2022-03-12 15:34:43 +00:00
elif datatype == " strdict " :
return { str ( k ) : str ( v ) for k , v in value . items ( ) }
2022-01-30 07:48:56 +00:00
else :
final_dict = { }
for dict_key , dict_data in value . items ( ) :
if isinstance ( dict_data , dict ) and dict_data :
2022-03-22 20:06:59 +00:00
new_data = { }
for dict_data_key , dict_data_data in dict_data . items ( ) :
new_data [ str ( dict_data_key ) ] = dict_data_data
final_dict [ dict_key ] = new_data
2022-01-30 07:48:56 +00:00
else :
raise Failed ( f " { error } Warning: { display } { dict_key } is not a dictionary " )
return final_dict
else :
raise Failed ( f " { error } Error: { display } { value } is not a dictionary " )
2022-01-28 18:36:21 +00:00
elif methods and attribute not in methods :
message = f " { display } not found "
elif value is None :
message = f " { display } is blank "
elif regex is not None :
regex_str , example = regex
if re . compile ( regex_str ) . match ( str ( value ) ) :
return str ( value )
else :
message = f " { display } : { value } must match pattern { regex_str } e.g. { example } "
elif datatype == " bool " :
if isinstance ( value , bool ) :
return value
elif isinstance ( value , ( int , float ) ) :
return value > 0
elif str ( value ) . lower ( ) in [ " t " , " true " ] :
return True
elif str ( value ) . lower ( ) in [ " f " , " false " ] :
return False
else :
message = f " { display } must be either true or false "
elif datatype in [ " int " , " float " ] :
2022-03-28 16:15:34 +00:00
if range_split :
range_values = str ( value ) . split ( range_split )
if len ( range_values ) == 2 :
start = check_int ( range_values [ 0 ] )
end = check_int ( range_values [ 1 ] )
if start and end and start < end :
return f " { start } { range_split } { end } "
2022-01-28 18:36:21 +00:00
else :
2022-03-28 16:15:34 +00:00
value = check_int ( value , datatype = datatype , minimum = minimum , maximum = maximum )
2022-04-17 17:40:23 +00:00
if value is not None :
2022-03-28 16:15:34 +00:00
return value
message = f " { display } { value } must { ' each ' if range_split else ' ' } be { ' an integer ' if datatype == ' int ' else ' a number ' } "
message = f " { message } { minimum } or greater " if maximum is None else f " { message } between { minimum } and { maximum } "
if range_split :
message = f " { message } separated by a { range_split } "
2022-01-28 18:36:21 +00:00
elif ( translation is not None and str ( value ) . lower ( ) not in translation ) or \
( options is not None and translation is None and str ( value ) . lower ( ) not in options ) :
message = f " { display } { value } must be in { ' , ' . join ( [ str ( o ) for o in options ] ) } "
else :
return translation [ value ] if translation is not None else value
if default is None :
raise Failed ( f " { error } Error: { message } " )
else :
logger . warning ( f " { error } Warning: { message } using { default } as default " )
return translation [ default ] if translation is not None else default
2022-02-13 18:28:53 +00:00
def replace_label ( _label , _data ) :
replaced = False
if isinstance ( _data , dict ) :
final_data = { }
for sm , sd in _data . items ( ) :
try :
_new_data , _new_replaced = replace_label ( _label , sd )
final_data [ sm ] = _new_data
if _new_replaced :
replaced = True
except Failed :
continue
elif isinstance ( _data , list ) :
final_data = [ ]
for li in _data :
try :
_new_data , _new_replaced = replace_label ( _label , li )
final_data . append ( _new_data )
if _new_replaced :
replaced = True
except Failed :
continue
elif " <<smart_label>> " in str ( _data ) :
final_data = str ( _data ) . replace ( " <<smart_label>> " , _label )
replaced = True
else :
final_data = _data
return final_data , replaced
2022-04-21 18:24:56 +00:00
def check_time ( message , end = False ) :
global previous_time
global start_time
current_time = time . time ( )
if end :
previous_time = start_time
if previous_time is None :
logger . debug ( f " { message } : { current_time } " )
start_time = current_time
else :
logger . debug ( f " { message } : { current_time - previous_time } " )
previous_time = None if end else current_time
2022-05-12 19:10:03 +00:00
2022-05-31 13:29:37 +00:00
system_fonts = [ ]
2022-05-15 03:06:32 +00:00
def get_system_fonts ( ) :
2022-05-31 13:29:37 +00:00
global system_fonts
if not system_fonts :
dirs = [ ]
if sys . platform == " win32 " :
windir = os . environ . get ( " WINDIR " )
if windir :
dirs . append ( os . path . join ( windir , " fonts " ) )
elif sys . platform in ( " linux " , " linux2 " ) :
lindirs = os . environ . get ( " XDG_DATA_DIRS " , " " )
if not lindirs :
lindirs = " /usr/share "
dirs + = [ os . path . join ( lindir , " fonts " ) for lindir in lindirs . split ( " : " ) ]
elif sys . platform == " darwin " :
dirs + = [ " /Library/Fonts " , " /System/Library/Fonts " , os . path . expanduser ( " ~/Library/Fonts " ) ]
else :
return dirs
system_fonts = [ n for d in dirs for _ , _ , ns in os . walk ( d ) for n in ns ]
return system_fonts
2022-05-15 03:06:32 +00:00
2022-05-12 19:10:03 +00:00
class YAML :
def __init__ ( self , path = None , input_data = None , check_empty = False , create = False ) :
self . path = path
self . input_data = input_data
self . yaml = ruamel . yaml . YAML ( )
self . yaml . indent ( mapping = 2 , sequence = 2 )
try :
if input_data :
self . data = self . yaml . load ( input_data )
else :
if create and not os . path . exists ( self . path ) :
with open ( self . path , ' w ' ) :
pass
self . data = { }
else :
with open ( self . path , encoding = " utf-8 " ) as fp :
self . data = self . yaml . load ( fp )
except ruamel . yaml . error . YAMLError as e :
e = str ( e ) . replace ( " \n " , " \n " )
raise Failed ( f " YAML Error: { e } " )
except Exception as e :
raise Failed ( f " YAML Error: { e } " )
if not self . data or not isinstance ( self . data , dict ) :
if check_empty :
raise Failed ( " YAML Error: File is empty " )
self . data = { }
def save ( self ) :
if self . path :
2022-05-16 13:59:46 +00:00
with open ( self . path , ' w ' , encoding = " utf-8 " ) as fp :
2022-05-12 19:10:03 +00:00
self . yaml . dump ( self . data , fp )
2022-05-15 03:06:32 +00:00
2022-06-02 06:32:00 +00:00
portrait_dim = ( 1000 , 1500 )
landscape_dim = ( 1920 , 1080 )
2022-06-03 15:46:25 +00:00
def parse_cords ( data , parent , required = False ) :
horizontal_align = parse ( " Overlay " , " horizontal_align " , data [ " horizontal_align " ] , parent = parent ,
options = [ " left " , " center " , " right " ] ) if " horizontal_align " in data else " left "
vertical_align = parse ( " Overlay " , " vertical_align " , data [ " vertical_align " ] , parent = parent ,
options = [ " top " , " center " , " bottom " ] ) if " vertical_align " in data else " top "
horizontal_offset = None
if " horizontal_offset " in data and data [ " horizontal_offset " ] is not None :
x_off = data [ " horizontal_offset " ]
per = False
if str ( x_off ) . endswith ( " % " ) :
x_off = x_off [ : - 1 ]
per = True
x_off = check_num ( x_off )
error = f " Overlay Error: { parent } horizontal_offset: { data [ ' horizontal_offset ' ] } must be a number "
if x_off is None :
raise Failed ( error )
if horizontal_align != " center " and not per and x_off < 0 :
raise Failed ( f " { error } 0 or greater " )
elif horizontal_align != " center " and per and ( x_off > 100 or x_off < 0 ) :
raise Failed ( f " { error } between 0% and 100% " )
elif horizontal_align == " center " and per and ( x_off > 50 or x_off < - 50 ) :
raise Failed ( f " { error } between -50% and 50% " )
horizontal_offset = f " { x_off } % " if per else x_off
if horizontal_offset is None and horizontal_align == " center " :
horizontal_offset = 0
if required and horizontal_offset is None :
raise Failed ( f " Overlay Error: { parent } horizontal_offset is required " )
vertical_offset = None
if " vertical_offset " in data and data [ " vertical_offset " ] is not None :
y_off = data [ " vertical_offset " ]
per = False
if str ( y_off ) . endswith ( " % " ) :
y_off = y_off [ : - 1 ]
per = True
y_off = check_num ( y_off )
error = f " Overlay Error: { parent } vertical_offset: { data [ ' vertical_offset ' ] } must be a number "
if y_off is None :
raise Failed ( error )
if vertical_align != " center " and not per and y_off < 0 :
raise Failed ( f " { error } 0 or greater " )
elif vertical_align != " center " and per and ( y_off > 100 or y_off < 0 ) :
raise Failed ( f " { error } between 0% and 100% " )
elif vertical_align == " center " and per and ( y_off > 50 or y_off < - 50 ) :
raise Failed ( f " { error } between -50% and 50% " )
vertical_offset = f " { y_off } % " if per else y_off
if vertical_offset is None and vertical_align == " center " :
vertical_offset = 0
if required and vertical_offset is None :
raise Failed ( f " Overlay Error: { parent } vertical_offset is required " )
return horizontal_align , horizontal_offset , vertical_align , vertical_offset
2022-05-15 03:06:32 +00:00
class Overlay :
2022-06-27 06:15:54 +00:00
def __init__ ( self , config , library , original_mapping_name , overlay_data , suppress ) :
2022-05-15 03:06:32 +00:00
self . config = config
self . library = library
2022-06-27 06:15:54 +00:00
self . original_mapping_name = original_mapping_name
2022-05-15 03:06:32 +00:00
self . data = overlay_data
self . suppress = suppress
self . keys = [ ]
self . updated = False
self . image = None
2022-05-18 17:07:15 +00:00
self . landscape = None
2022-06-02 06:32:00 +00:00
self . landscape_box = None
self . portrait = None
self . portrait_box = None
2022-05-15 03:06:32 +00:00
self . group = None
2022-06-03 15:46:25 +00:00
self . queue = None
2022-05-15 03:06:32 +00:00
self . weight = None
self . path = None
self . font = None
2022-05-15 20:29:54 +00:00
self . font_name = None
2022-05-17 07:25:11 +00:00
self . font_size = 36
2022-05-15 03:06:32 +00:00
self . font_color = None
2022-06-23 14:10:03 +00:00
self . addon_offset = 0
self . addon_position = None
2022-06-22 07:19:15 +00:00
2022-05-15 03:06:32 +00:00
logger . debug ( " " )
logger . debug ( " Validating Method: overlay " )
logger . debug ( f " Value: { self . data } " )
2022-05-15 20:29:54 +00:00
if not isinstance ( self . data , dict ) :
self . data = { " name " : str ( self . data ) }
logger . warning ( f " Overlay Warning: No overlay attribute using mapping name { self . data } as the overlay name " )
2022-06-23 15:31:54 +00:00
if " name " not in self . data or not self . data [ " name " ] :
raise Failed ( f " Overlay Error: overlay must have the name attribute " )
self . name = str ( self . data [ " name " ] )
2022-06-27 06:15:54 +00:00
if self . original_mapping_name not in library . overlay_names :
library . overlay_names . append ( self . original_mapping_name )
self . mapping_name = self . original_mapping_name
2022-06-23 15:31:54 +00:00
else :
name_count = 1
2022-06-27 06:15:54 +00:00
test_name = f " { self . original_mapping_name } ( { name_count } ) "
2022-06-23 15:31:54 +00:00
while test_name in library . overlay_names :
name_count + = 1
2022-06-27 06:15:54 +00:00
test_name = f " { self . original_mapping_name } ( { name_count } ) "
2022-06-23 15:31:54 +00:00
library . overlay_names . append ( test_name )
self . mapping_name = test_name
2022-05-15 20:29:54 +00:00
if " group " in self . data and self . data [ " group " ] :
self . group = str ( self . data [ " group " ] )
2022-06-03 15:46:25 +00:00
if " queue " in self . data and self . data [ " queue " ] :
self . queue = str ( self . data [ " queue " ] )
2022-05-17 07:25:11 +00:00
if " weight " in self . data :
2022-06-03 15:46:25 +00:00
self . weight = parse ( " Overlay " , " weight " , self . data [ " weight " ] , datatype = " int " , parent = " overlay " , minimum = 0 )
if " group " in self . data and ( self . weight is None or not self . group ) :
raise Failed ( f " Overlay Error: overlay attribute ' s group requires the weight attribute " )
elif " queue " in self . data and ( self . weight is None or not self . queue ) :
raise Failed ( f " Overlay Error: overlay attribute ' s queue requires the weight attribute " )
elif self . group and self . queue :
raise Failed ( f " Overlay Error: overlay attribute ' s group and queue cannot be used together " )
self . horizontal_align , self . horizontal_offset , self . vertical_align , self . vertical_offset = parse_cords ( self . data , " overlay " )
2022-05-15 20:29:54 +00:00
2022-05-17 07:25:11 +00:00
if ( self . horizontal_offset is None and self . vertical_offset is not None ) or ( self . vertical_offset is None and self . horizontal_offset is not None ) :
2022-06-07 20:42:17 +00:00
raise Failed ( f " Overlay Error: overlay attribute ' s horizontal_offset and vertical_offset must be used together " )
2022-05-29 07:28:25 +00:00
def color ( attr ) :
if attr in self . data and self . data [ attr ] :
try :
return ImageColor . getcolor ( self . data [ attr ] , " RGBA " )
except ValueError :
raise Failed ( f " Overlay Error: overlay { attr } : { self . data [ attr ] } invalid " )
self . back_color = color ( " back_color " )
self . back_radius = parse ( " Overlay " , " back_radius " , self . data [ " back_radius " ] , datatype = " int " , parent = " overlay " ) if " back_radius " in self . data else None
self . back_line_width = parse ( " Overlay " , " back_line_width " , self . data [ " back_line_width " ] , datatype = " int " , parent = " overlay " ) if " back_line_width " in self . data else None
self . back_line_color = color ( " back_line_color " )
self . back_padding = parse ( " Overlay " , " back_padding " , self . data [ " back_padding " ] , datatype = " int " , parent = " overlay " , default = 0 ) if " back_padding " in self . data else 0
2022-06-23 14:10:03 +00:00
self . back_align = parse ( " Overlay " , " back_align " , self . data [ " back_align " ] , parent = " overlay " , default = " center " , options = [ " left " , " right " , " center " , " top " , " bottom " ] ) if " back_align " in self . data else " center "
2022-06-02 06:32:00 +00:00
self . back_box = None
back_width = parse ( " Overlay " , " back_width " , self . data [ " back_width " ] , datatype = " int " , parent = " overlay " , minimum = 0 ) if " back_width " in self . data else - 1
back_height = parse ( " Overlay " , " back_height " , self . data [ " back_height " ] , datatype = " int " , parent = " overlay " , minimum = 0 ) if " back_height " in self . data else - 1
if ( back_width > = 0 and back_height < 0 ) or ( back_height > = 0 and back_width < 0 ) :
2022-05-29 07:28:25 +00:00
raise Failed ( f " Overlay Error: overlay attributes back_width and back_height must be used together " )
2022-06-23 14:10:03 +00:00
if self . back_align != " center " and ( back_width < 0 or back_height < 0 ) :
raise Failed ( f " Overlay Error: overlay attribute back_align only works when back_width and back_height are used " )
2022-06-02 06:32:00 +00:00
elif back_width > = 0 and back_height > = 0 :
self . back_box = ( back_width , back_height )
2022-06-03 15:46:25 +00:00
self . has_back = True if self . back_color or self . back_line_color else False
2022-06-07 20:42:17 +00:00
if self . has_back and not self . has_coordinates ( ) and not self . queue :
2022-05-29 07:28:25 +00:00
raise Failed ( f " Overlay Error: horizontal_offset and vertical_offset are required when using a backdrop " )
2022-05-15 20:29:54 +00:00
def get_and_save_image ( image_url ) :
response = self . config . get ( image_url )
if response . status_code > = 400 :
raise Failed ( f " Overlay Error: Overlay Image not found at: { image_url } " )
if " Content-Type " not in response . headers or response . headers [ " Content-Type " ] != " image/png " :
raise Failed ( f " Overlay Error: Overlay Image not a png: { image_url } " )
if not os . path . exists ( library . overlay_folder ) or not os . path . isdir ( library . overlay_folder ) :
os . makedirs ( library . overlay_folder , exist_ok = False )
logger . info ( f " Creating Overlay Folder found at: { library . overlay_folder } " )
clean_image_name , _ = validate_filename ( self . name )
image_path = os . path . join ( library . overlay_folder , f " { clean_image_name } .png " )
if os . path . exists ( image_path ) :
os . remove ( image_path )
with open ( image_path , " wb " ) as handler :
handler . write ( response . content )
while is_locked ( image_path ) :
time . sleep ( 1 )
return image_path
2022-06-21 06:12:47 +00:00
if not self . name . startswith ( " blur " ) :
2022-05-15 20:29:54 +00:00
if " file " in self . data and self . data [ " file " ] :
self . path = self . data [ " file " ]
elif " git " in self . data and self . data [ " git " ] :
self . path = get_and_save_image ( f " { github_base } { self . data [ ' git ' ] } .png " )
elif " repo " in self . data and self . data [ " repo " ] :
self . path = get_and_save_image ( f " { self . config . custom_repo } { self . data [ ' repo ' ] } .png " )
elif " url " in self . data and self . data [ " url " ] :
self . path = get_and_save_image ( self . data [ " url " ] )
2022-06-21 06:12:47 +00:00
if " | " in self . name :
raise Failed ( f " Overlay Error: Overlay Name: { self . name } cannot contain ' | ' " )
elif self . name . startswith ( " blur " ) :
2022-05-15 20:29:54 +00:00
try :
match = re . search ( " \\ (([^)]+) \\ ) " , self . name )
if not match or 0 > = int ( match . group ( 1 ) ) > 100 :
raise ValueError
self . name = f " blur( { match . group ( 1 ) } ) "
except ValueError :
logger . error ( f " Overlay Error: failed to parse overlay blur name: { self . name } defaulting to blur(50) " )
self . name = " blur(50) "
elif self . name . startswith ( " text " ) :
2022-06-08 12:38:53 +00:00
if not self . has_coordinates ( ) and not self . queue :
2022-05-16 01:25:35 +00:00
raise Failed ( f " Overlay Error: overlay attribute ' s horizontal_offset and vertical_offset are required when using text " )
2022-06-21 06:12:47 +00:00
if self . path :
if not os . path . exists ( self . path ) :
raise Failed ( f " Overlay Error: Text Overlay Addon Image not found at: { self . path } " )
self . addon_offset = parse ( " Overlay " , " addon_offset " , self . data [ " addon_offset " ] , datatype = " int " , parent = " overlay " ) if " addon_offset " in self . data else 0
2022-06-23 14:10:03 +00:00
self . addon_position = parse ( " Overlay " , " addon_position " , self . data [ " addon_position " ] , parent = " overlay " , options = [ " left " , " right " , " top " , " bottom " ] ) if " addon_position " in self . data else " left "
2022-06-21 06:12:47 +00:00
image_compare = None
if self . config . Cache :
2022-06-22 07:19:15 +00:00
_ , image_compare , _ = self . config . Cache . query_image_map ( self . mapping_name , f " { self . library . image_table_name } _overlays " )
2022-06-21 06:12:47 +00:00
overlay_size = os . stat ( self . path ) . st_size
self . updated = not image_compare or str ( overlay_size ) != str ( image_compare )
try :
self . image = Image . open ( self . path ) . convert ( " RGBA " )
if self . config . Cache :
2022-06-22 07:19:15 +00:00
self . config . Cache . update_image_map ( self . mapping_name , f " { self . library . image_table_name } _overlays " , self . name , overlay_size )
2022-06-21 06:12:47 +00:00
except OSError :
raise Failed ( f " Overlay Error: overlay image { self . path } failed to load " )
2022-05-15 20:29:54 +00:00
match = re . search ( " \\ (([^)]+) \\ ) " , self . name )
if not match :
raise Failed ( f " Overlay Error: failed to parse overlay text name: { self . name } " )
self . name = f " text( { match . group ( 1 ) } ) "
2022-05-31 13:29:37 +00:00
self . font_name = os . path . join ( os . path . dirname ( os . path . dirname ( os . path . abspath ( __file__ ) ) ) , " fonts " , " Roboto-Medium.ttf " )
2022-05-17 07:25:11 +00:00
if " font_size " in self . data :
self . font_size = parse ( " Overlay " , " font_size " , self . data [ " font_size " ] , datatype = " int " , parent = " overlay " , default = self . font_size )
2022-05-15 20:29:54 +00:00
if " font " in self . data and self . data [ " font " ] :
font = str ( self . data [ " font " ] )
if not os . path . exists ( font ) :
fonts = get_system_fonts ( )
if font not in fonts :
raise Failed ( f " Overlay Error: font: { font } not found. Options: { ' , ' . join ( fonts ) } " )
self . font_name = font
2022-06-11 02:05:16 +00:00
self . font = ImageFont . truetype ( self . font_name , self . font_size )
if " font_style " in self . data and self . data [ " font_style " ] :
try :
variation_names = [ n . decode ( " utf-8 " ) for n in self . font . get_variation_names ( ) ]
if self . data [ " font_style " ] in variation_names :
self . font . set_variation_by_name ( self . data [ " font_style " ] )
else :
raise Failed ( f " Overlay Error: Font Style { self . data [ ' font_style ' ] } not found. Options: { ' , ' . join ( variation_names ) } " )
except OSError :
logger . warning ( f " Overlay Warning: font: { self . font } does not have variations " )
2022-05-29 07:28:25 +00:00
self . font_color = None
if " font_color " in self . data and self . data [ " font_color " ] :
try :
self . font_color = ImageColor . getcolor ( self . data [ " font_color " ] , " RGBA " )
except ValueError :
raise Failed ( f " Overlay Error: overlay font_color: { self . data [ ' font_color ' ] } invalid " )
2022-06-22 07:19:15 +00:00
if self . name not in special_text_overlays :
2022-06-21 06:12:47 +00:00
box = self . image . size if self . image else None
2022-06-22 07:19:15 +00:00
self . portrait , self . portrait_box = self . get_backdrop ( portrait_dim , box = box , text = self . name [ 5 : - 1 ] )
self . landscape , self . landscape_box = self . get_backdrop ( landscape_dim , box = box , text = self . name [ 5 : - 1 ] )
2022-05-15 03:06:32 +00:00
else :
2022-05-15 20:29:54 +00:00
if not self . path :
clean_name , _ = validate_filename ( self . name )
self . path = os . path . join ( library . overlay_folder , f " { clean_name } .png " )
if not os . path . exists ( self . path ) :
raise Failed ( f " Overlay Error: Overlay Image not found at: { self . path } " )
image_compare = None
if self . config . Cache :
2022-06-22 07:19:15 +00:00
_ , image_compare , _ = self . config . Cache . query_image_map ( self . mapping_name , f " { self . library . image_table_name } _overlays " )
2022-05-15 20:29:54 +00:00
overlay_size = os . stat ( self . path ) . st_size
self . updated = not image_compare or str ( overlay_size ) != str ( image_compare )
try :
2022-06-02 06:32:00 +00:00
self . image = Image . open ( self . path ) . convert ( " RGBA " )
if self . has_coordinates ( ) :
2022-06-03 13:08:19 +00:00
self . portrait , self . portrait_box = self . get_backdrop ( portrait_dim , box = self . image . size )
self . landscape , self . landscape_box = self . get_backdrop ( landscape_dim , box = self . image . size )
2022-05-15 20:29:54 +00:00
if self . config . Cache :
2022-06-22 07:19:15 +00:00
self . config . Cache . update_image_map ( self . mapping_name , f " { self . library . image_table_name } _overlays " , self . mapping_name , overlay_size )
2022-05-15 20:29:54 +00:00
except OSError :
raise Failed ( f " Overlay Error: overlay image { self . path } failed to load " )
2022-05-15 03:06:32 +00:00
2022-06-03 15:46:25 +00:00
def get_backdrop ( self , canvas_box , box = None , text = None , new_cords = None ) :
2022-06-02 06:32:00 +00:00
overlay_image = None
2022-06-23 14:10:03 +00:00
text_width = None
text_height = None
image_width , image_height = box if box else ( None , None )
2022-06-02 06:32:00 +00:00
if text is not None :
2022-06-23 14:10:03 +00:00
_ , _ , text_width , text_height = self . get_text_size ( text )
if image_width is not None and self . addon_position in [ " left " , " right " ] :
box = ( text_width + image_width + self . addon_offset , text_height if text_height > image_height else image_height )
elif image_width is not None :
box = ( text_width if text_width > image_width else image_width , text_height + image_height + self . addon_offset )
2022-06-21 06:12:47 +00:00
else :
2022-06-23 14:10:03 +00:00
box = ( text_width , text_height )
box_width , box_height = box
back_width , back_height = self . back_box if self . back_box else ( None , None )
start_x , start_y = self . get_coordinates ( canvas_box , box , new_cords = new_cords )
main_x = start_x
main_y = start_y
2022-06-03 15:46:25 +00:00
if text is not None or self . has_back :
2022-06-02 06:32:00 +00:00
overlay_image = Image . new ( " RGBA " , canvas_box , ( 255 , 255 , 255 , 0 ) )
drawing = ImageDraw . Draw ( overlay_image )
2022-06-03 15:46:25 +00:00
if self . has_back :
2022-06-02 06:32:00 +00:00
cords = (
2022-06-23 14:10:03 +00:00
start_x - self . back_padding ,
start_y - self . back_padding ,
start_x + ( back_width if self . back_box else box_width ) + self . back_padding ,
start_y + ( back_height if self . back_box else box_height ) + self . back_padding
2022-06-02 06:32:00 +00:00
)
if self . back_radius :
drawing . rounded_rectangle ( cords , fill = self . back_color , outline = self . back_line_color , width = self . back_line_width , radius = self . back_radius )
else :
drawing . rectangle ( cords , fill = self . back_color , outline = self . back_line_color , width = self . back_line_width )
2022-06-23 14:10:03 +00:00
if self . back_box :
if self . back_align == " left " :
main_x = start_x
2022-07-05 18:12:31 +00:00
main_y = start_y + ( back_height - box_height ) / / 2
2022-06-23 14:10:03 +00:00
elif self . back_align == " right " :
main_x = start_x + back_width - ( text_width if text is not None else image_width )
elif self . back_align == " top " :
2022-07-05 18:12:31 +00:00
main_x = start_x + ( back_width - box_width ) / / 2
2022-06-23 14:10:03 +00:00
main_y = start_y
elif self . back_align == " bottom " :
main_y = start_y + back_height - ( text_height if text is not None else image_height )
else :
main_x = start_x + ( back_width - box_width ) / / 2
2022-06-23 19:12:28 +00:00
main_y = start_y + ( back_height - box_height ) / / 2
2022-06-23 14:10:03 +00:00
addon_x = None
addon_y = None
if text is not None and image_width :
addon_x = main_x
addon_y = main_y
if self . addon_position == " left " :
if self . back_align == " left " :
main_x = start_x + self . addon_offset
elif self . back_align == " right " :
addon_x = start_x + back_width - self . addon_offset
else :
main_x = addon_x + image_width + self . addon_offset
elif self . addon_position == " right " :
if self . back_align == " left " :
addon_x = start_x + self . addon_offset
elif self . back_align == " right " :
addon_x = start_x + back_width - image_width
main_x = start_x + back_width - self . addon_offset
else :
addon_x = main_x + text_width + self . addon_offset
elif text_width == image_width :
addon_x = main_x
elif text_width < image_width :
addon_x = main_x
main_x = main_x + ( ( image_width - text_width ) / 2 )
2022-06-21 06:12:47 +00:00
else :
2022-06-23 14:10:03 +00:00
addon_x = main_x + ( ( image_width - text_width ) / 2 )
if self . addon_position == " top " :
if self . back_align == " top " :
main_y = start_y + self . addon_offset
elif self . back_align == " bottom " :
addon_y = start_y + back_height - self . addon_offset
else :
main_y = addon_y + image_height + self . addon_offset
elif self . addon_position == " bottom " :
if self . back_align == " top " :
addon_y = start_y + self . addon_offset
elif self . back_align == " bottom " :
addon_y = start_y + back_height - image_height
main_y = start_y + back_height - self . addon_offset
else :
addon_y = main_y + text_height + self . addon_offset
elif text_height == image_height :
addon_y = main_y
elif text_height < image_height :
addon_y = main_y
main_y = main_y + ( ( image_height - text_height ) / 2 )
2022-06-21 06:12:47 +00:00
else :
2022-06-23 14:10:03 +00:00
addon_y = main_y + ( ( image_height - text_height ) / 2 )
2022-06-21 06:12:47 +00:00
2022-06-02 06:32:00 +00:00
if text is not None :
2022-06-28 20:52:28 +00:00
drawing . text ( ( int ( main_x ) , int ( main_y ) ) , text , font = self . font , fill = self . font_color , anchor = " lt " )
2022-06-23 14:10:03 +00:00
if addon_x is not None :
main_x = addon_x
main_y = addon_y
2022-06-28 20:52:28 +00:00
return overlay_image , ( int ( main_x ) , int ( main_y ) )
2022-06-02 06:32:00 +00:00
2022-05-15 03:06:32 +00:00
def get_overlay_compare ( self ) :
2022-06-23 15:31:54 +00:00
output = f " { self . name } "
2022-05-15 03:06:32 +00:00
if self . group :
output + = f " { self . group } { self . weight } "
2022-05-16 01:25:35 +00:00
if self . has_coordinates ( ) :
output + = f " { self . horizontal_align } { self . horizontal_offset } { self . vertical_offset } { self . vertical_align } "
2022-05-15 20:29:54 +00:00
if self . font_name :
output + = f " { self . font_name } { self . font_size } "
2022-06-02 06:32:00 +00:00
if self . back_box :
2022-06-30 13:14:09 +00:00
output + = f " { self . back_box [ 0 ] } { self . back_box [ 1 ] } { self . back_align } "
2022-06-23 14:10:03 +00:00
if self . addon_position is not None :
output + = f " { self . addon_position } { self . addon_offset } "
for value in [ self . font_color , self . back_color , self . back_radius , self . back_padding , self . back_line_color , self . back_line_width ] :
2022-05-17 07:25:11 +00:00
if value is not None :
output + = f " { value } "
2022-05-15 03:06:32 +00:00
return output
2022-05-15 20:29:54 +00:00
2022-05-16 01:25:35 +00:00
def has_coordinates ( self ) :
2022-05-16 03:08:14 +00:00
return self . horizontal_offset is not None and self . vertical_offset is not None
2022-05-16 01:25:35 +00:00
2022-05-17 07:25:11 +00:00
def get_text_size ( self , text ) :
return ImageDraw . Draw ( Image . new ( " RGBA " , ( 0 , 0 ) ) ) . textbbox ( ( 0 , 0 ) , text , font = self . font , anchor = ' lt ' )
2022-06-03 15:46:25 +00:00
def get_coordinates ( self , canvas_box , box , new_cords = None ) :
if new_cords is None and not self . has_coordinates ( ) :
2022-05-16 01:25:35 +00:00
return 0 , 0
2022-06-02 06:32:00 +00:00
if self . back_box :
box = self . back_box
2022-05-16 01:25:35 +00:00
def get_cord ( value , image_value , over_value , align ) :
2022-05-16 13:25:51 +00:00
value = int ( image_value * 0.01 * int ( value [ : - 1 ] ) ) if str ( value ) . endswith ( " % " ) else value
2022-05-16 01:25:35 +00:00
if align in [ " right " , " bottom " ] :
return image_value - over_value - value
elif align == " center " :
2022-05-16 13:25:51 +00:00
return int ( image_value / 2 ) - int ( over_value / 2 ) + value
2022-05-16 01:25:35 +00:00
else :
return value
2022-06-03 15:46:25 +00:00
if new_cords is None :
ho = self . horizontal_offset
ha = self . horizontal_align
vo = self . vertical_offset
va = self . vertical_align
else :
ha , ho , va , vo = new_cords
return get_cord ( ho , canvas_box [ 0 ] , box [ 0 ] , ha ) , get_cord ( vo , canvas_box [ 1 ] , box [ 1 ] , va )