kapsikkum-unmanic – Rev 1
?pathlinks?
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
unmanic.libraryscanner.py
Written by: Josh.5 <jsunnex@gmail.com>
Date: 20 Aug 2021, (5:37 PM)
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 gc
import json
import os
import queue
import threading
import time
import psutil
import schedule
from unmanic import config
from unmanic.libs import common, unlogger
from unmanic.libs.filetest import FileTesterThread
from unmanic.libs.library import Library
from unmanic.libs.plugins import PluginsHandler
class LibraryScannerManager(threading.Thread):
def __init__(self, data_queues, event):
super(LibraryScannerManager, self).__init__(name='LibraryScannerManager')
self.interval = 0
self.firstrun = True
self.data_queues = data_queues
self.settings = config.Config()
self.logger = None
self.event = event
self.scheduledtasks = data_queues["scheduledtasks"]
self.library_scanner_triggers = data_queues["library_scanner_triggers"]
self.abort_flag = threading.Event()
self.abort_flag.clear()
self.scheduler = schedule.Scheduler()
self.file_test_managers = {}
self.files_to_test = queue.Queue()
self.files_to_process = queue.Queue()
def _log(self, message, message2='', level="info"):
if not self.logger:
unmanic_logging = unlogger.UnmanicLogger.__call__()
self.logger = unmanic_logging.get_logger(self.name)
message = common.format_message(message, message2)
getattr(self.logger, level)(message)
def stop(self):
self.abort_flag.set()
# Stop all child threads
self.stop_all_file_test_managers()
def abort_is_set(self):
# Check if the abort flag is set
if self.abort_flag.is_set():
# Return True straight away if it is
return True
# Sleep for a fraction of a second to prevent CPU pinning
self.event.wait(.1)
# Return False
return False
def run(self):
self._log("Starting LibraryScanner Monitor loop")
while not self.abort_is_set():
self.event.wait(1)
# Main loop to configure the scheduler
if int(self.settings.get_schedule_full_scan_minutes()) != self.interval:
self.interval = int(self.settings.get_schedule_full_scan_minutes())
if self.interval and self.interval != 0:
self._log("Setting LibraryScanner schedule to scan every {} mins...".format(self.interval))
# Configure schedule
self.scheduler.every(self.interval).minutes.do(self.scheduled_job)
# Register application
self.register_unmanic()
# First run the task
if self.settings.get_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_is_set():
# Delay for 1 second before checking again.
self.event.wait(1)
# Check if a manual library scan was triggered
try:
if not self.library_scanner_triggers.empty():
trigger = self.library_scanner_triggers.get_nowait()
if trigger == "library_scan":
self.scheduled_job()
break
except queue.Empty:
continue
except Exception as e:
self._log("Exception in retrieving library scanner trigger {}:".format(self.name), message2=str(e),
level="exception")
# Check if library scanner is enabled
if not self.settings.get_enable_library_scanner():
# The library scanner is not enabled. Dont run anything
continue
# Check if scheduled task is due
self.scheduler.run_pending()
# If the settings have changed, then break this loop and clear
# the scheduled job resetting to the new interval
if int(self.settings.get_schedule_full_scan_minutes()) != self.interval:
self._log("Resetting LibraryScanner schedule")
break
self.scheduler.clear()
self._log("Leaving LibraryScanner Monitor loop...")
def scheduled_job(self):
"""
Function called by the scheduled task
:return:
"""
if not self.system_configuration_is_valid():
self._log("Skipping library scanner due invalid system configuration.", level='warning')
return
# For each configured library, check if a library scan is required
no_libraries_configured = True
for lib_info in Library.get_all_libraries():
no_libraries_configured = False
try:
library = Library(lib_info['id'])
except Exception as e:
self._log("Unable to fetch library config for ID {}".format(lib_info['id']), level='exception')
continue
# Check if the library is configured for remote files only
if library.get_enable_remote_only():
# This library is configured to receive remote files only... Never run a library scan on it
continue
# Check if library scanner is enabled on any library
if library.get_enable_scanner():
# Run library scan
self._log("Running full library scan on library '{}'".format(library.get_name()))
self.scan_library_path(library.get_path(), library.get_id())
if no_libraries_configured:
self._log("No libraries are configured to run a library scan")
def system_configuration_is_valid(self):
"""
Check and ensure the system configuration is correct for running
:return:
"""
valid = True
plugin_handler = PluginsHandler()
if plugin_handler.get_incompatible_enabled_plugins(self.data_queues.get('frontend_messages')):
valid = False
if not Library.within_library_count_limits(self.data_queues.get('frontend_messages')):
valid = False
return valid
def add_path_to_queue(self, pathname, library_id, priority_score):
self.scheduledtasks.put({
'pathname': pathname,
'library_id': library_id,
'priority_score': priority_score,
})
def start_results_manager_thread(self, manager_id, status_updates, library_id):
manager = FileTesterThread("FileTesterThread-{}".format(manager_id), self.files_to_test,
self.files_to_process, status_updates, library_id, self.event)
manager.daemon = True
manager.start()
self.file_test_managers[manager_id] = manager
def stop_all_file_test_managers(self):
for manager_id in self.file_test_managers:
self.file_test_managers[manager_id].abort_flag.set()
def scan_library_path(self, library_path, library_id):
"""
Run a scan of the given library path
:param library_path:
:param library_id:
:return:
"""
if not os.path.exists(library_path):
self._log("Path does not exist - '{}'".format(library_path), level="warning")
return
if self.settings.get_debugging():
self._log("Scanning directory - '{}'".format(library_path), level="debug")
# Push status notification to frontend
frontend_messages = self.data_queues.get('frontend_messages')
# Start X number of FileTesterThread threads
concurrent_file_testers = self.settings.get_concurrent_file_testers()
status_updates = queue.Queue()
self.file_test_managers = {}
for results_manager_id in range(int(concurrent_file_testers)):
self.start_results_manager_thread(results_manager_id, status_updates, library_id)
start_time = time.time()
frontend_messages.update(
{
'id': 'libraryScanProgress',
'type': 'status',
'code': 'libraryScanProgress',
'message': "Scanning directory - '{}'".format(library_path),
'timeout': 0
}
)
follow_symlinks = self.settings.get_follow_symlinks()
total_file_count = 0
current_file = ''
percent_completed_string = ''
for root, subFolders, files in os.walk(library_path, followlinks=follow_symlinks):
if self.abort_flag.is_set():
break
if self.settings.get_debugging():
self._log(json.dumps(files, indent=2), level="debug")
# Add all files in this path that match our container filter
for file_path in files:
if self.abort_flag.is_set():
break
# Place file's full path in queue to be tested
self.files_to_test.put(os.path.join(root, file_path))
total_file_count += 1
# Update status messages while fetching file list
if not status_updates.empty():
current_file = status_updates.get()
percent_completed_string = 'Testing: {}'.format(current_file)
frontend_messages.update(
{
'id': 'libraryScanProgress',
'type': 'status',
'code': 'libraryScanProgress',
'message': percent_completed_string,
'timeout': 0
}
)
# Loop while waiting for all threads to finish
double_check = 0
while not self.abort_flag.is_set():
frontend_messages.update(
{
'id': 'libraryScanProgress',
'type': 'status',
'code': 'libraryScanProgress',
'message': percent_completed_string,
'timeout': 0
}
)
# Check if all files have been tested
if self.files_to_test.empty() and self.files_to_process.empty() and status_updates.empty():
percent_completed_string = '100%'
# Add a "double check" section.
# This is used to ensure that the loop does not prematurely exit when the last file tests still
# progressing that have not yet made it to the "files_to_process" queue.
double_check += 1
if double_check > 5:
# There are not more files to test. Mark manager threads as completed
self.stop_all_file_test_managers()
break
self.event.wait(1)
continue
# Calculate percent of files tested
if not self.files_to_test.empty():
current_queue_size = self.files_to_test.qsize()
if int(total_file_count) > 0 and int(current_queue_size) > 0:
percent_remaining = int((int(current_queue_size) / int(total_file_count)) * 100)
percent_completed = int(100 - percent_remaining)
percent_completed_string = '{}% - Testing: {}'.format(percent_completed, current_file)
elif current_file:
percent_completed_string = '{}% - Testing: {}'.format('???', current_file)
# Fetch frontend messages from queue
if not status_updates.empty():
current_file = status_updates.get()
continue
elif not self.files_to_process.empty():
item = self.files_to_process.get()
self.add_path_to_queue(item.get('path'), library_id, item.get('priority_score'))
continue
else:
self.event.wait(.1)
# Wait for threads to finish
for manager_id in self.file_test_managers:
self.file_test_managers[manager_id].abort_flag.set()
self.file_test_managers[manager_id].join(2)
self._log("Library scan completed in {} seconds".format((time.time() - start_time)), level="warning")
# Run a manual garbage collection
gc.collect()
# Remove frontend status message
frontend_messages.remove_item('libraryScanProgress')
def register_unmanic(self):
from unmanic.libs import session
s = session.Session()
s.register_unmanic()