def run_init(storage_path, use_sso=False, skip_cert_verify=False):
config = ConfigHelper(storage_path)
if config.is_present():
do_override_input = cutie.prompt_yes_or_no(
Log.error_str('Do you want to override the existing config?'))
if not do_override_input:
sys.exit(0)
MailService(config).interactively_configure()
TelegramService(config).interactively_configure()
XmppService(config).interactively_configure()
do_sentry = cutie.prompt_yes_or_no(
'Do you want to configure Error Reporting via Sentry?')
if do_sentry:
sentry_dsn = input('Please enter your Sentry DSN: ')
config.set_property('sentry_dsn', sentry_dsn)
moodle = MoodleService(config, storage_path, skip_cert_verify)
if use_sso:
moodle.interactively_acquire_sso_token()
else:
moodle.interactively_acquire_token()
Log.success('Configuration finished and saved!')
if os.name != 'nt':
if storage_path == '.':
Log.info(
' To set a cron-job for this program on your Unix-System:\n' +
' 1. `crontab -e`\n' +
' 2. Add `*/15 * * * * cd "{}" && moodle-dl`\n'.format(
os.getcwd()) + ' 3. Save and you\'re done!')
else:
Log.info(
' To set a cron-job for this program on your Unix-System:\n' +
' 1. `crontab -e`\n' +
' 2. Add `*/15 * * * * cd "{}" && moodle-dl -p "{}"`\n'.
format(os.getcwd(), storage_path) +
' 3. Save and you\'re done!')
print('')
Log.info(
'You can always do the additional configuration later with the --config option.'
)
do_config = cutie.prompt_yes_or_no(
'Do you want to make additional configurations now?')
if do_config:
run_configure(storage_path, skip_cert_verify)
print('')
Log.success('All set and ready to go!')
def run_init(storage_path, use_sso=False, skip_cert_verify=False):
config = ConfigHelper(storage_path)
if config.is_present():
do_override_input = cutie.prompt_yes_or_no(Log.error_str('Do you want to override the existing config?'))
if not do_override_input:
sys.exit(0)
MailService(config).interactively_configure()
TelegramService(config).interactively_configure()
XmppService(config).interactively_configure()
do_sentry = cutie.prompt_yes_or_no('Do you want to configure Error Reporting via Sentry?')
if do_sentry:
sentry_dsn = input('Please enter your Sentry DSN: ')
config.set_property('sentry_dsn', sentry_dsn)
moodle = MoodleService(config, storage_path, skip_cert_verify)
if use_sso:
moodle.interactively_acquire_sso_token()
else:
moodle.interactively_acquire_token()
Log.success('Configuration finished and saved!')
if os.name != 'nt':
working_dir = os.path.abspath(storage_path)
moodle_dl_path = os.path.abspath(sys.argv[0])
Log.info(
' To set a cron-job for this program on your Unix-System:\n'
+ ' 1. `crontab -e`\n'
+ ' 2. Add `*/15 * * * * cd "{}" && "{}" >/dev/null 2>&1`\n'.format(working_dir, moodle_dl_path)
+ ' 3. Save and you\'re done!'
)
Log.info(
'For more ways to run `moodle-dl` periodically, take a look at the wiki (https://github.com/C0D3D3V/Moodle-Downloader-2/wiki/Start-Moodle-dl-periodically-or-via-Telegram)'
)
else:
Log.info(
'If you want to run moodle-dl periodically, you can take a look at the wiki (https://github.com/C0D3D3V/Moodle-Downloader-2/wiki/Start-Moodle-dl-periodically-or-via-Telegram)'
)
print('')
Log.info('You can always do the additional configuration later with the --config option.')
do_config = cutie.prompt_yes_or_no('Do you want to make additional configurations now?')
if do_config:
run_configure(storage_path, skip_cert_verify)
print('')
Log.success('All set and ready to go!')
def run_new_token(storage_path, use_sso=False, username: str = None, password: str = None, skip_cert_verify=False):
config = ConfigHelper(storage_path)
config.load() # because we do not want to override the other settings
moodle = MoodleService(config, storage_path, skip_cert_verify)
if use_sso:
moodle.interactively_acquire_sso_token(use_stored_url=True)
else:
moodle.interactively_acquire_token(use_stored_url=True, username=username, password=password)
Log.success('New Token successfully saved!')
def run_main(
storage_path,
verbose=False,
skip_cert_verify=False,
ignore_ytdl_errors=False,
without_downloading_files=False,
log_responses=False,
):
log_formatter = logging.Formatter(
'%(asctime)s %(levelname)s {%(module)s} %(message)s',
'%Y-%m-%d %H:%M:%S')
log_file = os.path.join(storage_path, 'MoodleDownloader.log')
log_handler = RotatingFileHandler(log_file,
mode='a',
maxBytes=1 * 1024 * 1024,
backupCount=2,
encoding='utf-8',
delay=0)
log_handler.setFormatter(log_formatter)
if verbose:
log_handler.setLevel(logging.DEBUG)
else:
log_handler.setLevel(logging.INFO)
app_log = logging.getLogger()
if verbose:
app_log.setLevel(logging.DEBUG)
else:
app_log.setLevel(logging.INFO)
app_log.addHandler(log_handler)
logging.info('--- moodle-dl started ---------------------')
Log.info('Moodle Downloader starting...')
if verbose:
logging.debug('moodle-dl version: %s', __version__)
logging.debug('python version: %s',
".".join(map(str, sys.version_info[:3])))
ffmpeg_available = which('ffmpeg') is not None
logging.debug('Is ffmpeg available: %s', ffmpeg_available)
if IS_DEBUG:
logging.info('Debug-Mode detected. Errors will be re-risen.')
app_log.addHandler(ReRaiseOnError())
try:
msg_load_config = 'Loading config...'
logging.debug(msg_load_config)
Log.debug(msg_load_config)
config = ConfigHelper(storage_path)
config.load()
except BaseException as e:
logging.error(
'Error while trying to load the Configuration! %s Exiting...',
e,
extra={'exception': e})
Log.error('Error while trying to load the Configuration!')
sys.exit(1)
r_client = False
try:
sentry_dsn = config.get_property('sentry_dsn')
if sentry_dsn:
sentry_sdk.init(sentry_dsn)
except BaseException:
pass
mail_service = MailService(config)
tg_service = TelegramService(config)
xmpp_service = XmppService(config)
console_service = ConsoleService(config)
PathTools.restricted_filenames = config.get_restricted_filenames()
try:
if not IS_DEBUG:
process_lock.lock(storage_path)
moodle = MoodleService(config, storage_path, skip_cert_verify,
log_responses)
msg_checking_for_changes = 'Checking for changes for the configured Moodle-Account....'
logging.debug(msg_checking_for_changes)
Log.debug(msg_checking_for_changes)
changed_courses = moodle.fetch_state()
if log_responses:
msg_responses_logged = (
"All JSON-responses from Moodle have been written to the responses.log file. Exiting..."
)
logging.debug(msg_responses_logged)
Log.success(msg_responses_logged)
process_lock.unlock(storage_path)
return
msg_start_downloading = 'Start downloading changed files...'
logging.debug(msg_start_downloading)
Log.debug(msg_start_downloading)
if without_downloading_files:
downloader = FakeDownloadService(changed_courses, moodle,
storage_path)
else:
downloader = DownloadService(changed_courses, moodle, storage_path,
skip_cert_verify, ignore_ytdl_errors)
downloader.run()
failed_downloads = downloader.get_failed_url_targets()
changed_courses_to_notify = moodle.recorder.changes_to_notify()
if len(changed_courses_to_notify) > 0:
console_service.notify_about_changes_in_moodle(
changed_courses_to_notify)
mail_service.notify_about_changes_in_moodle(
changed_courses_to_notify)
tg_service.notify_about_changes_in_moodle(
changed_courses_to_notify)
xmpp_service.notify_about_changes_in_moodle(
changed_courses_to_notify)
moodle.recorder.notified(changed_courses_to_notify)
else:
msg_no_changes = 'No changes found for the configured Moodle-Account.'
logging.info(msg_no_changes)
Log.warning(msg_no_changes)
if len(failed_downloads) > 0:
console_service.notify_about_failed_downloads(failed_downloads)
mail_service.notify_about_failed_downloads(failed_downloads)
tg_service.notify_about_failed_downloads(failed_downloads)
xmpp_service.notify_about_failed_downloads(failed_downloads)
process_lock.unlock(storage_path)
logging.debug('All done. Exiting...')
Log.success('All done. Exiting..')
except BaseException as e:
print('\n')
if not isinstance(e, process_lock.LockError):
process_lock.unlock(storage_path)
error_formatted = traceback.format_exc()
logging.error(error_formatted, extra={'exception': e})
if r_client:
sentry_sdk.capture_exception(e)
if verbose:
Log.critical('Exception:\n%s' % (error_formatted))
short_error = str(e)
if not short_error or short_error.isspace():
short_error = traceback.format_exc(limit=1)
console_service.notify_about_error(short_error)
mail_service.notify_about_error(short_error)
tg_service.notify_about_error(short_error)
xmpp_service.notify_about_error(short_error)
logging.debug('Exception-Handling completed. Exiting...')
sys.exit(1)
def interactively_manage_database(self):
RESET_SEQ = '\033[0m'
COLOR_SEQ = '\033[1;%dm'
BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(30, 38)
stored_files = self.state_recorder.get_stored_files()
stored_files = MoodleService.filter_courses(stored_files,
self.config_helper)
if len(stored_files) <= 0:
return
print('This management tool will navigate you through a menu to' +
' selectively remove file entries from the database so' +
' that these files can be downloaded again.')
course_options = []
courses = []
for course in stored_files:
for course_file in course.files:
if not os.path.exists(course_file.saved_to):
course_options.append(COLOR_SEQ % BLUE + course.fullname +
RESET_SEQ)
courses.append(course)
break
print('Choose one of the courses:')
print('[Confirm your selection with the Enter key]')
print('')
selected_course_id = cutie.select(options=course_options)
selected_course = courses[selected_course_id]
section_options = []
sections = []
for course_file in selected_course.files:
if not os.path.exists(course_file.saved_to) and (
course_file.section_name not in sections):
section_options.append(COLOR_SEQ % MAGENTA +
course_file.section_name + RESET_SEQ)
sections.append(course_file.section_name)
print('From which sections you want to select files.')
print(
'[You can select with the space bar and confirm your selection with the enter key]'
)
print('')
selected_sections_ids = cutie.select_multiple(options=section_options,
minimal_count=1)
selected_sections = []
for selected_sections_id in selected_sections_ids:
if selected_sections_id < len(sections):
selected_sections.append(sections[selected_sections_id])
file_options = []
files = []
for course_file in selected_course.files:
if not os.path.exists(course_file.saved_to) and (
course_file.section_name in selected_sections):
file_options.append(COLOR_SEQ % CYAN +
course_file.content_filename + RESET_SEQ)
files.append(course_file)
print(
'Which of the files should be removed form the database, so that they will be redownloaded?'
)
print(
'[You can select with the space bar and confirm your selection with the enter key]'
)
print('')
selected_files = cutie.select_multiple(options=file_options)
files_to_delete = []
for file_index in selected_files:
if file_index < len(files) and isinstance(files[file_index], File):
files_to_delete.append(files[file_index])
self.state_recorder.batch_delete_files_from_db(files_to_delete)
def interactively_manage_database(self):
RESET_SEQ = '\033[0m'
COLOR_SEQ = '\033[1;%dm'
BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(30, 38)
stored_files = self.state_recorder.get_stored_files()
stored_files = MoodleService.filter_courses(stored_files, self.config_helper)
if len(stored_files) <= 0:
return
course_options = []
courses = []
for course in stored_files:
for course_file in course.files:
if not os.path.exists(course_file.saved_to):
course_options.append(COLOR_SEQ % BLUE + course.fullname + RESET_SEQ)
courses.append(course)
break
print(
'This management tool will navigate you through a menu to'
+ ' selectively remove file entries from the database so'
+ ' that these files can be downloaded again.'
)
Log.warning(
'Only files that are missing locally but stored in the local'
+ ' database are displayed in this tool. If a file is not missing'
+ ' from a course, it will not be listed here at all. Also, only'
+ ' courses that are selected for download are displayed.'
)
Log.critical(
'For more complicated operations on the database a DB browser for SQLite'
+ ' is advantageous (https://sqlitebrowser.org/).'
)
if not courses:
print('No files are missing locally but stored in the local database. Nothing to do.')
return
print('Choose one of the courses:')
print('[Confirm your selection with the Enter key]')
print('')
selected_course_id = cutie.select(options=course_options)
selected_course = courses[selected_course_id]
section_options = []
sections = []
# Add the option to select all sections
section_options.append(COLOR_SEQ % MAGENTA + '[All sections]' + RESET_SEQ)
sections.append(None) # Add None at index 0 to avoid index shifting
for course_file in selected_course.files:
if not os.path.exists(course_file.saved_to) and (course_file.section_name not in sections):
section_options.append(COLOR_SEQ % MAGENTA + course_file.section_name + RESET_SEQ)
sections.append(course_file.section_name)
print('From which sections you want to select files?')
print('[You can select with the space bar and confirm your selection with the enter key]')
print('')
selected_sections_ids = cutie.select_multiple(options=section_options, minimal_count=1)
selected_sections = []
for selected_sections_id in selected_sections_ids:
if selected_sections_id == 0:
selected_sections = sections[1:]
break
elif (selected_sections_id) < len(sections):
selected_sections.append(sections[selected_sections_id])
file_options = []
files = []
# Add the option to select all files
file_options.append(COLOR_SEQ % CYAN + '[All files]' + RESET_SEQ)
files.append(None) # Add None at index 0 to avoid index shifting
for course_file in selected_course.files:
if not os.path.exists(course_file.saved_to) and (course_file.section_name in selected_sections):
file_options.append(COLOR_SEQ % CYAN + course_file.content_filename + RESET_SEQ)
files.append(course_file)
print('Which of the files should be removed form the database, so that they will be redownloaded?')
print('[You can select with the space bar and confirm your selection with the enter key]')
print('')
selected_files = cutie.select_multiple(options=file_options)
files_to_delete = []
for file_index in selected_files:
if file_index == 0: # If all files is selected
for file_to_delete in files[1:]: # Ignore the first element of the array set as None
if isinstance(file_to_delete, File):
files_to_delete.append(file_to_delete)
break
elif file_index < len(files) and isinstance(files[file_index], File):
files_to_delete.append(files[file_index])
self.state_recorder.batch_delete_files_from_db(files_to_delete)
def run_init(storage_path, use_sso=False, skip_cert_verify=False):
config = ConfigHelper(storage_path)
if config.is_present():
do_override_input = cutie.prompt_yes_or_no(Log.error_str('Do you want to override the existing config?'))
if not do_override_input:
sys.exit(0)
MailService(config).interactively_configure()
TelegramService(config).interactively_configure()
do_sentry = cutie.prompt_yes_or_no('Do you want to configure Error Reporting via Sentry?')
if do_sentry:
sentry_dsn = input('Please enter your Sentry DSN: ')
config.set_property('sentry_dsn', sentry_dsn)
moodle = MoodleService(config, storage_path, skip_cert_verify)
if use_sso:
moodle.interactively_acquire_sso_token()
else:
moodle.interactively_acquire_token()
if os.name != 'nt':
Log.info(
'On Windows many characters are forbidden in filenames and paths, if you want, these characters can be'
+ ' automatically removed from filenames.'
)
Log.warning('If you want to view the downloaded files on Windows this is important!')
default_windows_map = cutie.prompt_yes_or_no(
'Do you want to load the default filename character map for windows?'
)
if default_windows_map:
config.set_default_filename_character_map(True)
else:
config.set_default_filename_character_map(False)
else:
config.set_default_filename_character_map(True)
Log.success('Configuration finished and saved!')
if os.name != 'nt':
if storage_path == '.':
Log.info(
' To set a cron-job for this program on your Unix-System:\n'
+ ' 1. `crontab -e`\n'
+ ' 2. Add `*/15 * * * * cd %s && python3 %smain.py`\n'
% (os.getcwd(), os.path.join(os.path.dirname(os.path.realpath(__file__)), ''))
+ ' 3. Save and you\'re done!'
)
else:
Log.info(
' To set a cron-job for this program on your Unix-System:\n'
+ ' 1. `crontab -e`\n'
+ ' 2. Add `*/15 * * * *'
+ ' cd %s && python3 %smain.py --path %s`\n'
% (os.getcwd(), os.path.join(os.path.dirname(os.path.realpath(__file__)), ''), storage_path)
+ ' 3. Save and you\'re done!'
)
print('')
Log.info('You can always do the additional configuration later with the --config option.')
do_config = cutie.prompt_yes_or_no('Do you want to make additional configurations now?')
if do_config:
run_configure(storage_path, skip_cert_verify)
print('')
Log.success('All set and ready to go!')