youtube-sync

#!/usr/bin/env python

#||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# Author: Shane 'SajeOne' Brown
# Date: 13/03/2016
# Description: Syncs a youtube playlist with a local folder
#||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

import json
from pprint import pprint
import urllib.request as REQ
import urllib.error
import subprocess as sp
import os
from os.path import isfile, join, expanduser
import sys
import argparse
import re
import string

# LOCAL
from youtubesync.ytplaylist import YTPlaylist

# Get Directory of config.json
def getConfigDir():
    xdgConfigRaw = os.getenv("XDG_CONFIG_HOME")
    xdgConfig = str(xdgConfigRaw)

    if not xdgConfigRaw:
        if verbose:
            print("Warning: XDG_CONFIG_HOME not defined, attempting config read from local directory")

        # If config home not defined, default to free desktop spec
        home_path = os.getenv("HOME")
        xdgConfig = os.path.join(str(home_path), ".config")

    if not os.path.exists(xdgConfig + "/youtubeSync"):
        try:
            os.makedirs(xdgConfig + "/youtubeSync")
        except OSError:
            print("Could not write to CONFIG directory. Not owned by you?")
            return False


    xdgConfig += "/youtubeSync"
    return xdgConfig

# Load the config file into memory
def loadConfigFile(path):
    try:
        with open(path, "r") as configFile:
            data = configFile.read()
            jsonObj = json.loads(data)
            return jsonObj
    except (FileNotFoundError, IOError) as e:
        return False

# Write default config in the case one doesn't exist
def writeDefaultConfig():
    xdgConfig = getConfigDir() 

    musicDir = expanduser("~") + "/Music"

    configList = {'playlistID': 'PUT_PLAYLIST_ID_HERE', 'googleAPIKey': 'PUT_KEY_HERE', 'destination': musicDir}

    jsonSaveFile = json.dumps(configList, indent=4)
    with open(xdgConfig + "/config.json", "w") as configFile:
        print(jsonSaveFile, file=configFile)

    print("Created default config at " + xdgConfig)

# Download youtube video at URL specified and convert to mp3 in path folder
def downloadVideo(url, path):
    try:
        proc = sp.Popen(['yt-dlp', '--extract-audio', '--audio-format', 'mp3', '--output', path + "/%(title)s.%(ext)s", url], stdout=sp.PIPE)
    except FileNotFoundError as ex:
        raise ex
    result = proc.communicate()[0]
    status = proc.returncode
    

    if status == 0:
        return True

    return False

# Download Google API Json for playlist
def downloadPage(url):
    try:
        response = REQ.urlopen(url)
        data = response.read()
    except urllib.error.HTTPError as e:
        data = e.read()

    text = data.decode('utf-8')
    return text


# Decode the JSON to python DICT
def decodeJson(encodedJson):
    data = json.loads(encodedJson)
    return data

# convert list to form without any special characters or whitespace
def convertListFileSystemNeutral(convList):
    for index, value in enumerate(convList):
        convList[index] = re.sub('[^a-zA-Z\d]+', '', os.path.splitext(convList[index])[0])

    return convList


# convert string to form without any special characters or whitespace
def convertStringFileSystemNeutral(song):
    song = re.sub('[^a-zA-Z\d]+', '', song)
    return song

def getListDiff(list1, list2):
    tempList = []
    for item1 in list1: 
        item1Trunc = os.path.splitext(item1)[0]
        item1Trunc = convertStringFileSystemNeutral(item1Trunc)
        for item2 in list2: 
            item2 = convertStringFileSystemNeutral(item2)
            if item1Trunc == item2:
                tempList.append(item1)
    
    return list(set(list1) - set(tempList))

# Get list of songs from directory
def getSongList(path):
    songs = [f for f in os.listdir(path) if isfile(join(path, f))]
    return songs

# Handle json errors from Google API response
def errorHandleJson(jsonResp):
    reason = None
    if "error" in jsonResp:
        reason = jsonResp['error']['errors'][0]['reason']
        if reason == "keyInvalid":
            reason = "Invalid API Key"
        elif reason == "playlistNotFound":
            reason = "Could not find YouTube playlist"

    return reason

# Parse program arguments 
def parseArguments():
	parser = argparse.ArgumentParser()
	parser.add_argument('-t', '--id3tag', help="Automatically sets up ID3 tags based on '-' delimiter. Requires optional dependency 'python-mutagen'", action="store_true")
	parser.add_argument('-v', '--verbose', help="Includes skipped songs(Already downloaded and in active playlist)", action="store_true")
	parser.add_argument('-s', '--simulate', help="Simulates without actually downloading, good for speed testing", action="store_true")
	parser.add_argument('-c', '--config', help="Alternate config file location")
	parser.add_argument('--noapi', help="uses alternative method to youtube data api to grab meta data", action="store_true")
	args = parser.parse_args()
	return args

# Parses the raw result from yt api into title:id dicts
def objResultParser(obj):
	videos = list()

	for item in obj['items']:
		cur_video = dict()
		cur_video['title'] = item['snippet']['title']
		cur_video['id'] = item['snippet']['resourceId']['videoId']
		videos.append(cur_video)

	return videos

# Grab playlist meta using youtube data api
def getPlaylistDataAPI(url):
	## Download page and decode data
	video_bundle = list()

	cur_url = url
	while True:
		page = downloadPage(cur_url)

		jsonData = None
		try:
			jsonData = decodeJson(page)
		except json.decoder.JSONDecodeError:
			print("Error: Could not decode JSON response, ensure config.json is setup properly")
			sys.exit(1)

		response = errorHandleJson(jsonData)
		if response is not None:
			print("Error: " + response)
			sys.exit(1)

		cur_videos = objResultParser(jsonData)
		video_bundle = video_bundle + cur_videos

		if not 'nextPageToken' in jsonData.keys():
			break

		cur_url = url + "&pageToken=" + jsonData['nextPageToken']

	return video_bundle


# BEGIN EXECUTION

## Handle Arguments
args = parseArguments()

tagFiles = False
verbose = False
simulate = False

if args.id3tag:
   tagFiles = True

if args.verbose:
    verbose = True

if args.simulate:
    simulate = True


## Handle Configuration
xdgConfig = getConfigDir() + "/config.json"

if not xdgConfig:
    sys.exit(1)

if args.config == None or not isfile(args.config):
    config = loadConfigFile(xdgConfig)
else:
    config = loadConfigFile(args.config)

if not config:
    writeDefaultConfig()
    print("No config, wrote default. Ensure to edit appropriately")
    sys.exit(1)

if args.noapi:
	jsonData = YTPlaylist.fetchPlaylist(config['playlistID'])
	if jsonData != None and jsonData != False:
		print("Alternative Data Fetch Success")
else:
	url = "https://www.googleapis.com/youtube/v3/playlistItems?part=snippet&playlistId=" + config['playlistID'] + "&key=" + config['googleAPIKey'] + "&maxResults=50"
	jsonData = getPlaylistDataAPI(url)




songs = getSongList(config['destination'])
neutralSongs = convertListFileSystemNeutral(songs)

curSongList = []

## Loop through items and compare repos
for item in jsonData:
    curSongList.append(item['title'])

    neutralSnippet = convertStringFileSystemNeutral(item['title'])
    if not neutralSnippet in neutralSongs:
        print("Downloading " + item['title'] + "..")
        try:
            if not simulate and not downloadVideo("https://youtube.com/watch?v=" + item['id'], config['destination']):
                print("\n--DOWNLOAD FAILED--\n")
        except FileNotFoundError:
            print("youtube-dl not found, aborting..")
            sys.exit(1)
    else:
        if verbose:
            print("SKIPPING: ", end="")
            print(item['title'].encode('utf-8'))


## Delete songs removed from remote
songs = getSongList(config['destination'])

songsForDeletion = getListDiff(songs, curSongList)

for item in songsForDeletion:
    try:
        if not args.simulate:
            os.remove(config['destination'] + "/" + item)
        print("Removed " + item)
    except FileNotFoundError:
        print("Could not remove " + item)

## If -t flag add ID3 tags to files
if tagFiles: 
    if os.path.isfile("/usr/bin/mp3tags"):
        proc = sp.Popen(['mp3tags', '-p', config['destination']], stdout=sp.PIPE, stderr=sp.PIPE)
    elif os.path.isfile(os.path.dirname(os.path.realpath(__file__)) + "/mp3tags.py"):
        proc = sp.Popen(['python', 'mp3tags.py', '-p', config['destination']], stdout=sp.PIPE, stderr=sp.PIPE)
    else:
        print("Could not find mp3tags in /usr/bin or mp3tags.py in youtube-sync directory. Aborting tagging..")
        sys.exit(1)
    result = proc.communicate()[1]

    result = str(result).replace('\\n', '\n').replace("\\\'", '\'')

    if not proc.returncode:
        print("ID3 Tagged Files")
    else:
        print("\nFailed to tag files\n")