Фикс check_installed_tools() и проверка конфига

Reviewed-on: #13

.gitignore

@@ -3,3 +3,6 @@ config_python.py
 config_list.sh
 __pycache__
 .vscode
+.idea
+output.log*
+cfg_file.ini

README.md

@@ -1,22 +1,30 @@
 # Что это?
 
-Скрипт который проверяет и начинает запись стримов с твича (WIP)
+Скрипт, который записывает стримы с твича, удаляет старые, ведет красивый лог с цветами (Alpha)
 
 # Как юзать?
 
-* Поставить youtube-dl, python-twitch-client
+* Поставить youtube-dl, ffmpeg и другие пакеты из requirements.txt
 
-`pip3 install python-twitch-client youtube-dl`
+`apt install youtube-dl ffmpeg -y`
 
-* Создать файл conf_python.py и добавить свой ключ (Можно получить на https://dev.twitch.tv/console), а также переменные: 
+`pip install -r requirements.txt`
+
+* Создать файл conf_python.py и добавить свой ключ (Можно получить на https://dev.twitch.tv/console), а также переменные из config_python.py.template: 
 
 ```
-twitchid="ID" # ID ключа
+twitchid = "ID" # ID ключа
 streamers = ("jesusavgn", "252mart", "vi0xxx") # список стримеров в таком формате
-path="/путь/до/диры/со/стримами" # путь до директории, куда писать стримы
+path = "/путь/до/диры/со/стримами" # путь до директории, куда писать стримы
+check_period = 5 # Частота проверки стримеров (в секундах)
+max_files = 3 # Сколько хранить стримов
 ```
 
-* Добавить daemon.py в crontab, ну и офк убедиться что cron.service запущен (systemd timer не подойдет ибо он убивает child процессы после завершения работы родителя)
+* Запустить скрипт в screen'е или создать для него systemd.service файл (или init.d, в зависимости от системы инициализации)
 
-`*/5 * * * * /opt/twitch-downloader/cron.sh`
+# Updates
 
+## 2022-11-13
+
+В связи с переходом на новую библиотеку необходимо указывать 2 переменные авторизации - appid и appsecret. 
+twitchid это appid, а секретный ключ можно получить или перегенерировать в https://dev.twitch.tv/console 

config_python.py.template

@@ -1,4 +0,0 @@
-twitchid="....."
-streamers = ("jesusavgn", "252mart", "vi0xxx")
-path="/home/losted/test"
-period = 5

daemon.py

@@ -1,23 +1,111 @@
 #!/usr/bin/python3
 
-# FIXME: не создавать папки для несуществующих стримеров
+# TODO: Перезапускать скрипт при обнаружении новой версии
-# TODO: Сделать нормальную конфигурацию
-# TODO: Автоматически удалять старые стримы
 
 import os
+import sys
 from threading import Thread
-import config_python
+import configparser
 import schedule
-from twitch import TwitchClient
+from twitchAPI.twitch import Twitch
 import subprocess
 import time
+import logging
+from logging.handlers import TimedRotatingFileHandler
+
+log_format = logging.Formatter('%(asctime)s %(levelname)s - %(message)s')
+log_file = 'output.log'
+cfg_file = 'config.ini'
 
 
-def which(command):
+def get_console_handler():
+    console_handler = logging.StreamHandler(sys.stdout)
+    console_handler.setFormatter(log_format)
+    return console_handler
+
+
+def get_file_handler():
+    file_handler = TimedRotatingFileHandler(log_file, when='midnight')
+    file_handler.setFormatter(log_format)
+    return file_handler
+
+
+class CustomFormatter(logging.Formatter):
+
+    grey = "\x1b[38;20m"
+    yellow = "\x1b[33;20m"
+    red = "\x1b[31;20m"
+    bold_red = "\x1b[31;1m"
+    reset = "\x1b[0m"
+    format = "%(asctime)s %(levelname)s - %(message)s"
+
+    FORMATS = {
+        logging.DEBUG: grey + format + reset,
+        logging.INFO: grey + format + reset,
+        logging.WARNING: yellow + format + reset,
+        logging.ERROR: red + format + reset,
+        logging.CRITICAL: bold_red + format + reset
+    }
+
+    def format(self, record):
+        log_fmt = self.FORMATS.get(record.levelno)
+        formatter = logging.Formatter(log_fmt)
+        return formatter.format(record)
+
+
+def get_logger(logger_name):
+    """
+    Инициализация лога
+    """
+    logger = logging.getLogger(logger_name)
+    logger.setLevel(logging.DEBUG)
+
+    # Console logging
+    console = get_console_handler()
+    console.setFormatter(CustomFormatter())
+    logger.addHandler(console)
+
+    logger.addHandler(get_file_handler())
+    logger.propagate = False
+    return logger
+
+
+def set_config():
+    """
+    Эта функция либо читает существующий конфиг, либо создает новый.
+    Возвращает объект конфига (configparser.ConfigParser())
+    """
+    config = configparser.ConfigParser()
+    # Читаем конфиг, если пустой - заполняем
+    if not config.read('cfg_file.ini'):
+        config["app"] = {
+            "path": "",
+            "check_period": 5,
+            "max_files": 3
+        }
+        config["twitch"] = {
+            "app_id": "",
+            "app_secret": "",
+            "streamers": "t2x2,arcadia_online,252mart,the_viox"
+        }
+        with open('cfg_file.ini', 'w') as cfg_file:
+            config.write(cfg_file)
+
+    # Проверка конфига
+    if config['twitch']['app_id'] == "" or config['twitch']['app_secret'] == "":
+        log.critical("Параметры app_id или app_secret пусты. Необходимо заполнить эти параметры в конфиге. "
+                     "Читай README.md")
+        exit(1)
+
+    return config
+
+
+def which(command) -> bool:
     # Пиздец, почему нет нормального аналога which из bash???
-    '''
+    """
-    Мой аналог which из bash'а, который отдает true или false при наличии или отсутствии утилиты    
+    Мой аналог which из bash'а, который отдает true или false
-    '''
+    при наличии или отсутствии утилиты
+    """
     for dirs in os.get_exec_path():
         if command in os.listdir(dirs):
             # Если что-нибудь нашли, то True
@@ -25,80 +113,134 @@ def which(command):
     # Если ничего не нашли во всех дирах, то выходим с False
     return False
 
-def checkTools():
+
-    '''
+def check_installed_tools() -> bool:
+    """
     Проверяет, установлены ли необходимые утилиты
-    '''
+    """
     tools = ('youtube-dl', 'ffmpeg')
-    for i in tools:
+    for tool in tools:
-        if not which(i):
+        if not which(tool):
-            print(i + " не установлен")
+            log.critical("{} не установлен".format(tool))
             return False
     return True
 
-def startRecord(i):
-    '''
-    Функция, которая запускает в отдельном потоке запись стрима - recorder(i)
-    '''
-    th = Thread(target=recorder, args=(i, ))
-    th.start()
 
-def recorder(i):
+def recorder(streamer):
-    '''
+    """
     Функция, которая запускает youtube-dl, фактически записывает стрим
-    '''
+    """
-    path = config_python.path + "/"+ i
+    streamer_path = os.path.join(config['app']['path'], streamer)
-    print("Записываем стрим %s\n" % i)
+    log.info("Записываем стрим {}".format(streamer))
     # cmdline для запуска youtube-dl
-    # TODO: сделать возможность добавлять свои параметры
+    cmdline = ["youtube-dl", "-q", "-o",
-    cmdline = ["youtube-dl","https://twitch.tv/"+i]
+               streamer_path + "/%(upload_date)s_%(title)s__%(timestamp)s_%(id)s.%(ext)s",
-    s = subprocess.call(cmdline, stdout=subprocess.DEVNULL)
+               "https://twitch.tv/{}".format(streamer)]
-    print("Запись стрима %s закончена\n" % i)
+    subprocess.call(cmdline)
-    if (os.path.exists(path+"/pid")):
+    log.info("Запись стрима {} закончена".format(streamer))
-        os.system("rm "+path+"/pid")
+    if os.path.exists(os.path.join(streamer_path, "pid")):
-        print("lock файл удален")
+        os.remove(os.path.join(streamer_path, "pid"))
+        log.info("lock файл удален")
 
-def checkAlive():
+
-    streamers = config_python.streamers
+def get_streamer_id(streamer):
-    client_id = config_python.twitchid
+    """Получаем id стримера, при неудаче отдаем None"""
-    '''
+    resolved_id = twitch_client.get_users(logins=[streamer])
-    1. Проверка на наличие стрима
+    if resolved_id['data']:
-    1.1 Если нет - удалить lock файл, если он есть
+        return resolved_id['data'][0]['id']
-    1.2 Если есть - создать lock файл, запустить записывалку
+    else:
-    '''
+        log.error(
-    client = TwitchClient(client_id=client_id)
+            "Аккаунт {} не найден".format(streamer)
-    for i in streamers:
+        )
-        # Путь до диры со стримами
+        return None
-        path = config_python.path + "/"+ i
+
-        # Создаем путь до диры со стримером, если его нет
+
-        if not (os.path.exists(config_python.path+"/"+i)):
+def record_streamer(user_stream, streamer):
-            os.makedirs(path)
+    """Проверяем, идет ли стрим. Если идет - записываем. Если не идет - удаляем pid файл"""
-        # TODO: Сделать проверку на наличие стримера
+    streamer_path = os.path.join(config['app']['path'], streamer)
-        user_id=client.users.translate_usernames_to_ids(i)[0]['id'] # Получить ID по нику
+    if user_stream['data']:
-        # Если стрим идет, то идем дальше
+        # Создаем путь до диры со стримером, если папка не существует
-        if client.streams.get_stream_by_user(user_id):
+        if not (os.path.exists(streamer_path)):
-            # Если стрим идет и лок файла нет, то записываем и ставим лок
+            os.makedirs(streamer_path)
-            if (client.streams.get_stream_by_user(user_id).stream_type == 'live') and not (os.path.exists(config_python.path+"/"+i+"/pid")):
+            log.info("Создана директория {}".format(streamer_path))
-                print(i+" стримит")
+
-                startRecord(i)
+        # Если стрим идет и лок файла нет, то записываем и ставим лок
-                os.system("touch "+path+"/pid")
+        if (user_stream['data'][0]['type'] == 'live') and not (
-            else:
+                os.path.exists(os.path.join(streamer_path, "pid"))):
-                print(i+" Уже стримит")
+            log.info("{} стримит".format(streamer))
+            th = Thread(target=recorder, args=(streamer,))
+            th.start()
+            os.mknod(os.path.join(streamer_path, "pid"))
         else:
-            # Если стрим не идет, то пишем об этом и убираем его из залоченных
+            log.info(
-            print(i+" Не стримит")
+                "Идет запись {}".format(streamer)
-            # Если есть лок, то удаляем
+            )
-            if (os.path.exists(path+"/pid")):
+    else:
-                os.system("rm "+path+"/pid")
+        # Если стрим не идет, то пишем об этом и убираем его из залоченных
+        log.debug("{} не стримит".format(streamer))
+        # Если есть лок, то удаляем
+        if os.path.exists(os.path.join(streamer_path, "pid")):
+            os.remove(os.path.join(streamer_path, "pid"))
 
 
-def removeOldStreams():
+def streamers_loop():
+    """
+    Цикл по стримерам
+    Проходится по каждому логину, достает ID стримера,
+    достает инфу о стримах, запускает функцию для записи
+    """
+    for streamer in config['twitch']['streamers'].split(','):
+
+        # Достаем ID стримера, если пустой - пропускаем цикл
+        user_id = get_streamer_id(streamer)
+        if user_id is None:
+            continue
+        # Получаем данные о стриме
+        user_stream = twitch_client.get_streams(user_id=user_id)
+        # Запускаем запись
+        record_streamer(user_stream, streamer)
+
+
+def remove_old_streams():
     # https://clck.ru/WHh32
-    pass
+    records_path = config['app']['path']
+    # По каждой папке со стримерами
+    for streamer in config['twitch']['streamers']:
+        try:
+            streamer_dir_path = os.path.join(records_path, streamer)
+            os.chdir(streamer_dir_path)
+            # Если файлов в папке со стримами больше чем указано в конфиге
+            if len(os.listdir(streamer_dir_path)) > int(config['app']['max_files']):
+                # Получаем список файлов
+                # и смотрим, превышает ли кол-во mp4 файлов заданное в конфиге
+                # Если превышает - удаляем старейший
+                oldest = min(os.listdir(streamer_dir_path),
+                             key=os.path.getctime)
+                os.unlink(oldest)
+                log.warning("Удален файл: {}".format(oldest))
+        except Exception as e:
+            log.error(e)
+
 
 if __name__ == "__main__":
-    if not checkTools(): exit()
+    # Log config
-    schedule.every(config_python.period).minutes.do(checkAlive)
+    log = get_logger("main")
+
+    # Проверить, установлены ли нужные утилиты
+    if not check_installed_tools():
+        exit()
+
+    # Set config
+    config = set_config()
+
+    # Проверять стримы раз в check_period
+    # Каждый час удалять старые стримы
+    schedule.every(int(config['app']['check_period'])).seconds.do(streamers_loop)
+    schedule.every(1).hours.do(remove_old_streams)
+
+    # Инициализируем клиент твича
+    twitch_client = Twitch(config['twitch']['app_id'], config['twitch']['app_secret'])
+    log.info("Запущен")
     while True:
         schedule.run_pending()
         time.sleep(1)

requirements.txt

@@ -1,3 +1,3 @@
-youtube-dl==2021.4.17
+youtube-dl==2021.12.17
-python-twitch-client==0.7.1
+twitchAPI==2.5.7.1
-schedule
+schedule==1.2.0