service.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
###################################################################################################
#
#   Written by:               Josh.5 <jsunnex@gmail.com>
#   Date:                     Thu Dec 06 2018, (7:21:18 AM)
#
#   Copyright:
#          Copyright (C) Josh Sunnex - All Rights Reserved
#
#          Permission is hereby granted, free of charge, to any person obtaining a copy
#          of this software and associated documentation files (the "Software"), to deal
#          in the Software without restriction, including without limitation the rights
#          to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
#          copies of the Software, and to permit persons to whom the Software is
#          furnished to do so, subject to the following conditions:
# 
#          The above copyright notice and this permission notice shall be included in all
#          copies or substantial portions of the Software.
# 
#          THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
#          EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
#          MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
#          IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
#          DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
#          OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
#          OR OTHER DEALINGS IN THE SOFTWARE.
#
#
###################################################################################################


import os
import sys
import json
import time
import threading
import queue
import pyinotify
import schedule

import config
from lib import unlogger, common, ffmpeg
from lib.jobqueue import JobQueue
from lib.postprocessor import PostProcessor
from lib.uiserver import UIServer
from lib.worker import Worker

sys.path.append('lib')
sys.path.append('webserver')

unmanic_logging = unlogger.UnmanicLogger.__call__()
main_logger = unmanic_logging.get_logger()

threads = []


# The TaskHandler reads all items in the queues and passes them to the appropriate locations in the application.
# All messages are passed to the logger and all tasks are added to the job queue
class TaskHandler(threading.Thread):
    def __init__(self, data_queues, settings, job_queue):
        super(TaskHandler, self).__init__(name='TaskHandler')
        self.settings = settings
        self.job_queue = job_queue
        self.inotifytasks = data_queues["inotifytasks"]
        self.scheduledtasks = data_queues["scheduledtasks"]
        self.abort_flag = threading.Event()
        self.abort_flag.clear()

    def run(self):
        main_logger.info("Starting TaskHandler Monitor loop...")
        while not self.abort_flag.is_set():
            while not self.abort_flag.is_set() and not self.scheduledtasks.empty():
                try:
                    pathname = self.scheduledtasks.get_nowait()
                    if self.job_queue.add_item(pathname):
                        main_logger.info("Adding job to queue - {}".format(pathname))
                    else:
                        main_logger.info("Skipping job already in the queue - {}".format(pathname))
                except queue.Empty:
                    continue
                except Exception as e:
                    main_logger.error("Exception in processing scheduledtasks:", message2=str(e), level="exception")
            while not self.abort_flag.is_set() and not self.inotifytasks.empty():
                try:
                    pathname = self.inotifytasks.get_nowait()
                    if self.job_queue.add_item(pathname):
                        main_logger.info("Adding inotify job to queue - {}".format(pathname))
                    else:
                        main_logger.info("Skipping inotify job already in the queue - {}".format(pathname))
                except queue.Empty:
                    continue
                except Exception as e:
                    main_logger.error("Exception in processing inotifytasks:", message2=str(e), level="exception")
            time.sleep(.2)
        main_logger.info("Leaving TaskHandler Monitor loop...")


class LibraryScanner(threading.Thread):
    def __init__(self, data_queues, settings):
        super(LibraryScanner, self).__init__(name='LibraryScanner')
        self.interval = 0
        self.firstrun = True
        self.settings = settings
        self.logger = data_queues["logging"].get_logger(self.name)
        self.scheduledtasks = data_queues["scheduledtasks"]
        self.abort_flag = threading.Event()
        self.abort_flag.clear()
        self.ffmpeg = ffmpeg.FFMPEGHandle(settings, data_queues['logging'])

    def _log(self, message, message2='', level="info"):
        message = common.format_message(message, message2)
        getattr(self.logger, level)(message)

    def run(self):
        # If we have a config set to run a schedule, then start the process.
        # Otherwise close this thread now.
        while not self.abort_flag.is_set():
            # Main loop to configure the scheduler
            if int(self.settings.SCHEDULE_FULL_SCAN_MINS) != self.interval:
                self.interval = int(self.settings.SCHEDULE_FULL_SCAN_MINS)
            if self.interval and self.interval != 0:
                self._log("Starting LibraryScanner schedule to scan every {} mins...".format(self.interval))
                # Configure schedule
                schedule.every(self.interval).minutes.do(self.scheduled_job)

                # First run the task
                if self.settings.RUN_FULL_SCAN_ON_START and self.firstrun:
                    self._log("Running LibraryScanner on start")
                    self.scheduled_job()
                self.firstrun = False

                # Then loop and wait for the schedule
                while not self.abort_flag.is_set():
                    # TODO: Dont run scheduler if we already have a full queue
                    schedule.run_pending()
                    time.sleep(60)
                    if int(self.settings.SCHEDULE_FULL_SCAN_MINS) != self.interval:
                        break
                schedule.clear()
                self._log("Stopping LibraryScanner schedule...")
        time.sleep(5)

    def scheduled_job(self):
        self._log("Running full library scan")
        self.get_convert_files(self.settings.LIBRARY_PATH)

    def add_path_to_queue(self, pathname):
        self.scheduledtasks.put(pathname)

    def file_not_target_format(self, pathname):
        # Reset file in
        self.ffmpeg.file_in = {}
        # Check if file matches configured codec and format
        if not self.ffmpeg.check_file_to_be_processed(pathname):
            if self.settings.DEBUGGING:
                self._log("File does not need to be processed - {}".format(pathname))
            return False
        return True

    def get_convert_files(self, search_folder):
        self._log(search_folder)
        for root, subFolders, files in os.walk(search_folder):
            if self.settings.DEBUGGING:
                self._log(json.dumps(files, indent=2))
            # Add all files in this path that match our container filter
            for file_path in files:
                if file_path.lower().endswith(self.settings.SUPPORTED_CONTAINERS):
                    pathname = os.path.join(root, file_path)
                    # Check if this file is already the correct format:
                    if self.file_not_target_format(pathname):
                        self.add_path_to_queue(pathname)
                else:
                    if self.settings.DEBUGGING:
                        self._log("Ignoring file due to incorrect suffix - '{}'".format(file_path))


class EventProcessor(pyinotify.ProcessEvent):
    def __init__(self, data_queues, settings):
        self.name = "EventProcessor"
        self.settings = settings
        self.logger = data_queues["logging"].get_logger(self.name)
        self.inotifytasks = data_queues["inotifytasks"]
        self.abort_flag = threading.Event()
        self.abort_flag.clear()
        self.ffmpeg = ffmpeg.FFMPEGHandle(settings, data_queues['logging'])

    def _log(self, message, message2='', level="info"):
        message = common.format_message(message, message2)
        getattr(self.logger, level)(message)

    def inotify_enabled(self):
        if self.settings.INOTIFY:
            return True
        return False

    def add_path_to_queue(self, pathname):
        self.inotifytasks.put(pathname)

    def file_not_target_format(self, pathname):
        # Reset file in
        self.ffmpeg.file_in = {}
        # Check if file matches configured codec and format
        if not self.ffmpeg.check_file_to_be_processed(pathname):
            if self.settings.DEBUGGING:
                self._log("File does not need to be processed - {}".format(pathname))
            return False
        return True

    def process_IN_CLOSE_WRITE(self, event):
        if self.inotify_enabled():
            self._log("CLOSE_WRITE event detected:", event.pathname)
            if event.pathname.lower().endswith(self.settings.SUPPORTED_CONTAINERS):
                # Add it to the queue
                if self.file_not_target_format(event.pathname):
                    self.add_path_to_queue(event.pathname)
            else:
                if self.settings.DEBUGGING:
                    self._log("Ignoring file due to incorrect suffix - '{}'".format(event.pathname))

    def process_IN_MOVED_TO(self, event):
        if self.inotify_enabled():
            self._log("MOVED_TO event detected:", event.pathname)
            if event.pathname.lower().endswith(self.settings.SUPPORTED_CONTAINERS):
                # Add it to the queue
                if self.file_not_target_format(event.pathname):
                    self.add_path_to_queue(event.pathname)
            else:
                if self.settings.DEBUGGING:
                    self._log("Ignoring file due to incorrect suffix - '{}'".format(event.pathname))

    def process_IN_DELETE(self, event):
        if self.inotify_enabled():
            self._log("DELETE event detected:", event.pathname)
            self._log("Nothing to do for this event")

    def process_default(self, event):
        pass


def start_handler(data_queues, settings, job_queue):
    main_logger.info("Starting TaskHandler")
    handler = TaskHandler(data_queues, settings, job_queue)
    handler.daemon = True
    handler.start()
    return handler


def start_post_processor(data_queues, settings, job_queue):
    main_logger.info("Starting PostProcessor")
    postprocessor = PostProcessor(data_queues, settings, job_queue)
    postprocessor.daemon = True
    postprocessor.start()
    return postprocessor


def start_workers(data_queues, settings, job_queue):
    main_logger.info("Starting Workers")
    worker = Worker(data_queues, settings, job_queue)
    worker.daemon = True
    worker.start()
    return worker


def start_library_scanner_manager(data_queues, settings):
    main_logger.info("Starting LibraryScanner")
    scheduler = LibraryScanner(data_queues, settings)
    scheduler.daemon = True
    scheduler.start()
    return scheduler


def start_inotify_watch_manager(data_queues, settings):
    main_logger.info("Starting EventProcessor")
    wm = pyinotify.WatchManager()
    wm.add_watch(settings.LIBRARY_PATH, pyinotify.ALL_EVENTS, rec=True)
    # event processor
    ep = EventProcessor(data_queues, settings)
    # notifier
    notifier = pyinotify.ThreadedNotifier(wm, ep)
    return notifier


def start_ui_server(data_queues, settings, workerHandle):
    main_logger.info("Starting UI Server")
    uiserver = UIServer(data_queues, settings, workerHandle)
    uiserver.daemon = True
    uiserver.start()
    return uiserver


def main():
    # Read settings
    settings = config.CONFIG(main_logger)

    # Apply settings to logging
    unmanic_logging.setup_logger(settings)

    # Create our data queues
    data_queues = {
        "scheduledtasks": queue.Queue(),
        "inotifytasks": queue.Queue(),
        "progress_reports": queue.Queue(),
        "logging": unmanic_logging
    }

    # Clear cache directory
    common.clean_files_in_dir(settings.CACHE_PATH)

    # Setup job queue
    job_queue = JobQueue(settings, data_queues)

    # Setup post-processor thread
    start_post_processor(data_queues, settings, job_queue)

    # Start the worker threads
    worker_handle = start_workers(data_queues, settings, job_queue)

    # Start new thread to handle messages from service
    start_handler(data_queues, settings, job_queue)

    # Start new thread to run the web UI
    start_ui_server(data_queues, settings, worker_handle)

    # start scheduled thread
    start_library_scanner_manager(data_queues, settings)

    # start inotify watch manager
    notifier = start_inotify_watch_manager(data_queues, settings)
    notifier.loop()
    while True:
        time.sleep(5)

    # stop everything
    main_logger.info("Stopping all processes")
    scheduler.abort_flag.set()
    handler.abort_flag.set()
    scheduler.join()
    handler.join()
    main_logger.info("Exit")


if __name__ == "__main__":
    main()