axcore
/
tartube
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
tartube/tartube/mainapp.py

26603 lines
955 KiB
Python
Raw Permalink Blame History

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright (C) 2019-2022 A S Lewis
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
"""Main application class."""
# Import Gtk modules
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk, GObject, GdkPixbuf
# Import Python standard modules
from gi.repository import Gio
import datetime
import json
import locale
import math
import os
import pickle
import platform
import re
import shutil
import sys
import threading
import time
import gettext
_ = gettext.gettext
# Import other Python modules
try:
import feedparser
HAVE_FEEDPARSER_FLAG = True
except:
HAVE_FEEDPARSER_FLAG = False
try:
import matplotlib
HAVE_MATPLOTLIB_FLAG = True
except:
HAVE_MATPLOTLIB_FLAG = False
try:
import moviepy.editor
HAVE_MOVIEPY_FLAG = True
except:
HAVE_MOVIEPY_FLAG = False
try:
import playsound
HAVE_PLAYSOUND_FLAG = True
except:
HAVE_PLAYSOUND_FLAG = False
if os.name != 'nt':
try:
from xdg_tartube import XDG_CONFIG_HOME
HAVE_XDG_FLAG = True
except:
HAVE_XDG_FLAG = False
else:
HAVE_XDG_FLAG = False
if platform.system() != 'Windows' and platform.system != 'Darwin':
try:
gi.require_version('Notify', '0.7')
from gi.repository import Notify
HAVE_NOTIFY_FLAG = True
except:
HAVE_NOTIFY_FLAG = False
else:
HAVE_NOTIFY_FLAG = False
# Import our modules
import __main__
import classes
import config
import dialogue
import downloads
import ffmpeg_tartube
import files
import formats
import info
import mainwin
import media
import options
import process
import refresh
#import testing
import tidy
import updates
import utils
import wizwin
# Classes
class TartubeApp(Gtk.Application):
"""Main python class for the Tartube application."""
# Standard class methods
def __init__(self, *args, **kwargs):
# Register the application
if not __main__.__multiple_instance_flag__:
# Restrict Tartube to a single instance
super(TartubeApp, self).__init__(
*args,
application_id=__main__.__app_id__,
flags=Gio.ApplicationFlags.FLAGS_NONE,
**kwargs,
)
else:
# Permit multiple instances of Tartube
super(TartubeApp, self).__init__(
*args,
application_id=None,
flags=Gio.ApplicationFlags.FLAGS_NONE,
**kwargs,
)
# Debugging flags
# ---------------
# After installation, don't show wizard or dialogue windows, prompting
# the user to select various settings; just use default values
self.debug_no_dialogue_flag = False
# When loading a config/database file, if a lockfile is present, load
# the config/database file anyway (i.e., ignore lockfiles)
self.debug_ignore_lockfile_flag = False
# In the main window's menu, show a menu item for adding a set of
# media data objects for testing
self.debug_test_media_menu_flag = False
# In the main window's menu, show a menu item for executing some
# arbitrary test code (by calling testing.run_test_code())
self.debug_test_code_menu_flag = False
# Open the main window in the top-left corner of the desktop
self.debug_open_top_left_flag = False
# Automatically open the system preferences window on startup
self.debug_open_pref_win_flag = False
# Automatically open the general download options window on startup
self.debug_open_options_win_flag = False
# Hide all the system folders (this is not reversible by setting the
# flag back to False)
self.debug_hide_folders_flag = False
# Disable showing mainwin.NewbieDialogue altogether
self.debug_disable_newbie_flag = False
# Write the Gtk version to the terminal on startup
self.debug_write_gtk_flag = False
# Instance variable (IV) list - class objects
# -------------------------------------------
# The main window object, set as soon as it's created
self.main_win_obj = None
# The system tray icon (a mainwin.StatusIcon object, inheriting from
# Gtk.StatusIcon)
self.status_icon_obj = None
#
# At the moment, there are seven operations - the download, update,
# refresh, info, tidy, livestream and process operations
# Only one operation can be in progress at a time. When an operation is
# in progress, many functions (such as opening configuration windows)
# are not possible
#
# A download operation is handled by a downloads.DownloadManager
# object. It downloads files from a server (for example, it downloads
# videos from YouTube)
# Although its not possible to run more than one download
# operation at a time, a single download operation can handle
# multiple simultaneous downloads
# The current downloads.DownloadManager object, if a download operation
# is in progress (or None, if not)
self.download_manager_obj = None
# An update operation (to update youtube-dl) is handled by an
# updates.UpdateManager object. It updates youtube-dl to the latest
# version
# The current updates.UpdateManager object, if an upload operation is
# in progress (or None, if not)
self.update_manager_obj = None
# A refresh operation compares the media registry with the contents of
# Tartube's data directories, adding new videos to the media registry
# and marking missing videos as not downloaded, as appropriate
# The current refresh.RefreshManager object, if a refresh operation is
# in progress (or None, if not)
self.refresh_manager_obj = None
# An info operation fetches information about a particular video;
# currently, its available formats and available subtitles
# It can also perform a youtube-dl(c) test using specified download
# options; any downloaded files are stored in a temporary directory
# It can also check the Tartube website, to tell the user if a new
# release is available
# The current info.InfoManager object, if an info operation is in
# progress (or None, if not)
self.info_manager_obj = None
# A tidy operation can check that videos still exist and aren't
# corrupted, or can remove all videos, or all thumbnails, and so on
# The current tidy.TidyManager object, if a tidy operation is in
# progress (or None, if not)
self.tidy_manager_obj = None
# A livestream operation is handled by a downloads.StreamManager
# object. It checks media.Video objects marked as livestreams, to
# see whether have started or stopped broadcasting
# Livestreams operations can take place when a download operation is
# already running (but not when any other kind of operation is
# running)
# If a download operation is started when a livestream operation is
# running, the livestream operation is cancelled immediately
self.livestream_manager_obj = None
# A process operation is handled by a process.ProcessManager object. It
# sends a list of media.Video objects to FFmpeg for processing
# The current process.ProcessManager object, if a process operation is
# in progress (or None, if not)
self.process_manager_obj = None
#
# When an operation is in progress, the manager object is stored here
# (so code can quickly check if an operation is in progress, or not)
# Livestream operations run silently in the background, and no
# functionality is disabled. Therefore, this IV remains set to None
# when the livestream operation is running
self.current_manager_obj = None
#
# The file manager, files.FileManager, for loading thumbnail, icon
# and JSON files safely (i.e. without causing a Gtk crash)
self.file_manager_obj = files.FileManager()
# The FFmpeg manager, for when Tartube needs to call FFmpeg directly.
# Most of the code has been adapted from youtube-dl
self.ffmpeg_manager_obj = ffmpeg_tartube.FFmpegManager(self)
# The message dialogue manager, dialogue.DialogueManager, for showing
# message dialogue windows safely (i.e. without causing a Gtk crash)
self.dialogue_manager_obj = None
# Instance variable (IV) list - other
# -----------------------------------
# Flag set to True when startup is complete. Set to True by the last
# line of code in self.start_continue()
self.startup_complete_flag = False
# Custom locale (can match one of the values in formats.LOCALE_LIST)
self.custom_locale = locale.getdefaultlocale()[0]
# Default regex for handling video timestamps (a string in the form
# 'mm:ss' or 'h:mm:ss'. Leading zeroes are optional for all
# components, and the 'h' component can contain any number of digits)
self.timestamp_regex = r'((\d+)\:)?([0-5]?[0-9]):([0-5]?[0-9])'
# Default window sizes (in pixels)
self.main_win_width = 1000
self.main_win_height = 700
self.config_win_width = 650
self.config_win_height = 450
# Default slider position. This value applies to the sliders in the
# Videos, Progress and Classic Mode tabs
self.paned_default_size = 250
# Default size (in pixels) of space between various widgets
self.default_spacing_size = 5
# Default thumbnail sizes, assuming an original size of 1280x720. All
# sizes are available in the Video Catalogue, when videos are
# displayed as a grid; otherwise only the 'tiny' size is used
self.thumb_size_dict = {
'tiny' : [128, 72],
'small' : [256, 144],
'medium' : [384, 216],
'large' : [512, 288],
'enormous' : [640, 360],
}
# Ordered list of thumbnail sizes and translations, for use in various
# comboboxes
self.thumb_size_list = [
_('Tiny'), 'tiny',
_('Small'), 'small',
_('Medium'), 'medium',
_('Large'), 'large',
_('Enormous'), 'enormous',
]
# A custom thumbnail size; one of the keys in self.thumb_size_dict.
# Used when the Video Catalogue is displaying videos in a grid. (When
# displaying them as a list, the 'small' size is always used)
self.thumb_size_custom = 'small'
# Custom window sizes
# Flag set to True if Tartube should remember the main window size
# when saving the config file, and then use that size when
# re-starting tartube
self.main_win_save_size_flag = False
# Flag set to True if Tartube should remember the positions of the
# sliders in the Video, Progress and Classic Mode tabs. If False,
# the sliders have default positions. Ignored if
# self.main_win_save_size_flag is not True
self.main_win_save_slider_flag = False
# The size of the main window, when the config file was last saved...
self.main_win_save_width = self.main_win_width
self.main_win_save_height = self.main_win_height
# ...and the position of the sliders in the Videos, Progress and
# Classic Mode tabs, when the config file was last saved
self.main_win_videos_slider_posn = self.paned_default_size
self.main_win_progress_slider_posn = self.paned_default_size
self.main_win_classic_slider_posn = self.paned_default_size + 50
# Because of Gtk issues, resetting main window sliders to their default
# positions has to be done twice. Flag set to True if
# self.script_fast_timer_callback() should reset the position of
# sliders again
self.main_win_slider_reset_flag = False
# The current Gtk version
self.gtk_version_major = Gtk.get_major_version()
self.gtk_version_minor = Gtk.get_minor_version()
self.gtk_version_micro = Gtk.get_micro_version()
# Standard timeout (in seconds) for calls to the Python requests module
# when downloading a URL
self.request_get_timeout = 30
# IVs used to place a lock on the loaded database file, so that
# competing instances of Tartube don't try to use it at the same time
# Time to wait (in seconds) to save the config file, if a lockfile
# exists for it
self.config_lock_time = 5
# The path to the database lockfile created by this instance of
# Tartube (None if no lockfile has been created)
self.db_lock_file_path = None
# Flag set to True while self.load_db() is being executed, and set
# back to False when it stops
# If the code crashes because of a python error, it won't be obvious
# to the user that the load has failed. Instead, before starting an
# operation, this flag is checked and, if true, the operation does
# not start and load/save is disabled as normal
# N.B. This is a failsafe; in most cases, an interrupted database load
# leaves widgets such as the 'Check all' and 'Download all' buttons
# (in the Videos tab) desensitised anyway
self.db_loading_flag = False
# At all times (after initial setup), two GObject timers run - a fast
# one and a slow one
# The slow timer's ID
self.script_slow_timer_id = None
# The slow timer interval time (in milliseconds)
self.script_slow_timer_time = 30000
# A timer that calls self.script_slow_timer_callback() once, before
# the first call from self.script_slow_timer_id, and just a few
# seconds after Tartube starts
# (Any scheduled downloads which are due to start when Tartube starts,
# actually start a few seconds later, for aesthetic reasons)
self.script_once_timer_id = None
# The once-only timer interval (in milliseconds)
self.script_once_timer_time = 3000
# The fast timer's ID
self.script_fast_timer_id = None
# The fast timer interval time (in milliseconds)
self.script_fast_timer_time = 250
# Flag set to True if the main toolbar should not be drawn when the
# main window is opened
self.toolbar_hide_flag = False
# Flag set to True if the main toolbar should be compressed (by
# removing the labels); ideal if the toolbar's contents won't fit in
# the standard-sized window (as it almost certainly won't on MS
# Windows)
if os.name != 'nt':
self.toolbar_squeeze_flag = False
else:
self.toolbar_squeeze_flag = True
# Flag set to True if the 'Show' button on the main toolbar (which
# hides most system folders) is selected
self.toolbar_system_hide_flag = False
# Flag set to True if tooltips should be visible in the Video Index,
# Video Catalogue, Progress List, Results List and Classic Progress
# List
self.show_tooltips_flag = True
# Flag set to True if tooltips should include errors/warnings in the
# Progress List, Results List and Classic Progress List (only).
# Ignored if self.show_tooltips_flag is False
self.show_tooltips_extra_flag = True
# Flag set to True if stock icons in the Videos/Classic Mode tabs
# should be replaced by a custom set of icons (in case the stock
# icons are not visible, for some reason)
self.show_custom_icons_flag = True
# Flag set to True if a marker should be visible on each row in the
# Video Index, false if not
self.show_marker_in_index_flag = True
# Flag set to True if small icons should be used in the Video Index,
# False if large icons should be used
self.show_small_icons_in_index_flag = False
# Flag set to True if the Video Index treeview should auto-expand/
# auto-collapse when an item is clicked, to show/hide its children
# (only folders have children visible in the Video Index, though)
self.auto_expand_video_index_flag = False
# Flag set to True if the treeview should be fully expanded when an
# item is clicked; False if only the next level should be expanded
# (ignored if self.auto_expand_video_index_flag is False)
self.full_expand_video_index_flag = False
# Flag set to True if the 'Download all' and 'Custom download all'
# buttons in the main window toolbar and in the Videos tab should be
# disabled (in case the user is sure they only want to do simulated
# downloads)
# Does not apply to the download buttons in the Classic Mode tab
self.disable_dl_all_flag = False
# Flag set to True if a 'Custom download all' button should be visible
# in the Videos tab
self.show_custom_dl_button_flag = False
# Flag set to True if free disk space should be visible in the Videos
# tab during a download operation
self.show_free_space_flag = True
# Flag set to True if we should use 'Today' and 'Yesterday' in the
# Video Index, rather than a date
self.show_pretty_dates_flag = True
# In the Video Catalogue, flags set to True if we should filter videos
# by name, description and/or comments
self.catalogue_filter_name_flag = True
self.catalogue_filter_descrip_flag = False
self.catalogue_filter_comment_flag = False
# In the Video Catalogue, flag set to True if a frame should be drawn
# around each video, False if not
self.catalogue_draw_frame_flag = True
# In the Video Catalogue, flag set to True if status icons should be
# drawn, False if not
self.catalogue_draw_icons_flag = True
# In the Video Catalogue, flag set to True if downloaded videos should
# be drawn, False if not. Note that when a filter is applied, any
# matching videos are always visible, regardless of the value of this
# IV
self.catalogue_draw_downloaded_flag = True
# In the Video Catalogue, flag set to True if undownloaded videos
# should be drawn, False if not. Note that when a filter is applied,
# any matching videos are always visible, regardless of the value of
# this IV
self.catalogue_draw_undownloaded_flag = True
# In the Video Catalogue, flag set to True if blocked videos should be
# drawn, False if not. Note that when a filter is applied, any
# matching videos are always visible, regardless of the value of this
# IV
self.catalogue_draw_blocked_flag = False
# In the Video Catalogue, flag set to True if channel/playlist names
# should be clickable (in grid mode only)
self.catalogue_clickable_container_flag = True
# In the Video Catalogue, flag set to True if the video .nickname
# should be displayed, or False if the video .name should be
# displayed
self.catalogue_show_nickname_flag = True
# Flags specifying what data should be transferred to an external
# application, if videos are dragged there from the Video Catalogue
# (and also from the Results List and Classic Progress List)
# All or any of the flags may be set. If none are set, no data is
# transferred
# Flag set to True if the full file path should be transferred
self.drag_video_path_flag = True
# Flag set to True if the video's source URL should be transferred
self.drag_video_source_flag = False
# Flag set to True if the video's name should be transferred
self.drag_video_name_flag = False
# Flag set to True if the full file path to the thumbnail file should
# be transferred
self.drag_thumb_path_flag = False
# Flag set to True if an icon should be displayed in the system tray
self.show_status_icon_flag = True
# Flag set to True if Tartube should open in the system tray. Ignored
# if self.show_status_icon_flag is False
self.open_in_tray_flag = False
# Flag set to True if the main window should close to the tray, rather
# than halting the application altogether. Ignored if
# self.show_status_icon_flag is False
self.close_to_tray_flag = False
# Flag set to True if Tartube should remember the position of the main
# window, when it is closed to the tray. (Does not work at all on
# Wayland, and does not apply when Tartube shuts down and restarts)
self.restore_posn_from_tray_flag = False
# Flag set to True if rows in the Progress List should be hidden once
# the download operation has finished with the corresponding media
# data object (so the user can see the media data objects currently
# being downloaded more easily)
self.progress_list_hide_flag = False
# Flag set to True if new rows should be added to the Results List
# at the top, False if they should be added at the bottom
self.results_list_reverse_flag = False
# Flag set to True if system error messages should be shown in the
# Errors/Warnings tab
self.system_error_show_flag = True
# Flag set to True if system warning messages should be shown in the
# Errors/Warnings tab
self.system_warning_show_flag = True
# Flag set to True if operation error messages should be shown in the
# Errors/Warnings tab
self.operation_error_show_flag = True
# Flag set to True if operation warning messages should be shown in the
# Errors/Warnings tab
self.operation_warning_show_flag = True
# Flag set to True if the date (as well as the time) should be shown in
# the Errors/Warnings tab
self.system_msg_show_date_flag = True
# Flag set to True if the channel/playlist/folder name should be shown
# in the Errors/Warnings tab
self.system_msg_show_container_flag = True
# Flag set to True if the video name should be shown in the Errors/
# Warnings tab
self.system_msg_show_video_flag = True
# Flag set to True if the multi-line messages should be shown in the
# Errors/ Warnings tab
self.system_msg_show_multi_line_flag = True
# Flag set to True if the total number of system error/warning messages
# visible (not including hidden messages) in the tab label is not
# reset until the 'Clear the list' button is explicitly clicked
# (normally, the total numbers are reset when the user switches to a
# different tab)
self.system_msg_keep_totals_flag = False
# For quick lookup, the directory in which the 'tartube' executable
# file is found, and its parent directory
self.script_dir = sys.path[0]
self.script_parent_dir = os.path.abspath(
os.path.join(self.script_dir, os.pardir),
)
# Tartube's data directory (platform-dependent), i.e. 'tartube-data'
# Note that, using the MSWin installer, Cygwin gives file paths with
# both / and \ separators. Throughout the code, we use
# os.path.abspath to circumvent this problem
self.default_data_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
),
)
self.data_dir = self.default_data_dir
# A list of data directories used recently by the user. The list
# includes the current value of self.data_dir, and can be
# customised by the user (to forget directories no longer needed)
# Multiple instances of Tartube can use the same config file, but
# they cannot use the same database file at the same time
# When Tartube starts, if the database file in the directory
# self.data_dir is locked, Tartube will try other directories in this
# list, in order, until finding one that isn't locked
self.data_dir_alt_list = [ self.data_dir ]
# self.data_dir records the path to the database file that was in
# memory, when the config file was last saved. Flag set to False to
# use this path (meaning that, on startup, the same database file is
# loaded), or True if the first path in self.data_dir_alt_list is
# loaded instead
self.data_dir_use_first_flag = True
# On startup (but not when switching databases), if the database file
# in self.data_dir is locked, when this flag is True Tartube will try
# other directories in self.data_dir_alt_list (as described above).
# If False, only self.data_dir is tried
self.data_dir_use_list_flag = True
# When switching to a new database file, the data directory (containing
# the file) is added to the list, if the flag it True
self.data_dir_add_from_list_flag = True
# The data directory is structured like this:
# /tartube-data
# tartube.db [the Tartube database file]
# /.backups
# tartube_BU.db [any number of database file backups]
# /.temp [temporary directory, deleted on startup]
# /pewdiepie [example of a custom media.Channel]
# /Temporary Videos [standard media.Folder]
# /Unsorted Videos [standard media.Folder]
# /Video Clips [standard media.Folder]
# Before v1.3.099, the data directory was structured like this:
# /tartube-data
# tartube.db
# tartube_BU.db
# /.temp
# /downloads
# /pewdiepie
# /Temporary Videos
# /Unsorted Videos
# Tartube can read from both stcuctures although, when creating a new
# data directory, only the new structure is created
#
# The sub-directory into which videos are downloaded (new and old
# style)
self.downloads_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
),
)
self.alt_downloads_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
'downloads',
),
)
# A hidden directory, used for storing backups of the Tartube database
# file
self.backup_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
'.backups',
),
)
# A temporary directory, deleted when Tartube starts and stops
self.temp_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
'.temp',
),
)
# Inside the temporary directory, a downloads folder, replicating the
# layout of self.downloads_dir, and used for storing description,
# JSON and thumbnail files which the user doesn't want to store in
# self.downloads_dir
self.temp_dl_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
'.temp',
'downloads',
),
)
# Inside the temporary directory, a test folder into which an info
# operation can allow youtube-dl to download files
self.temp_test_dir = os.path.abspath(
os.path.join(
os.path.expanduser('~'),
__main__.__packagename__ + '-data',
'.temp',
'ytdl-test',
),
)
# When the user tries to switch databases (in a call to
# self.switch_db() ), we make backup copies of those IVs. If the
# switch fails, then their values can be restored, and the user can
# continue using the old database as normal
self.backup_data_dir = None
self.backup_downloads_dir = None
self.backup_alt_downloads_dir = None
self.backup_backup_dir = None
self.backup_temp_dir = None
self.backup_temp_dl_dir = None
self.backup_temp_test_dir = None
self.backup_data_dir_alt_list = None
# The user can opt to move thumbnails to a '.thumbs' sub-directory, and
# other metadata files to a '.data' sub-directory (by setting the
# download options 'move_description', etc)
# The names of those sub-directories
self.thumbs_sub_dir = '.thumbs'
self.metadata_sub_dir = '.data'
# By default, Tartube passes a path to a cookie jar to youtube-dl(c),
# to prevent it writing one to ../tartube/tartube. The name of the
# default file, which is stored in the data directory
# If the options manager specifies a different path, then that path is
# passed to youtube-dl(c) instead
self.cookie_file_name = 'cookies.txt'
# The directory in which sound files are found, set in the call to
# self.find_sound_effects()
self.sound_dir = None
# List of sound files found in the ../sounds directory (e.g.
# 'beep.mp3')
self.sound_list = []
# The user's preferred sound effect (for livestream alarms)
self.sound_custom = 'bell.mp3'
# Name of the Tartube config file
self.config_file_name = 'settings.json'
# The config file can be stored at one of two locations, depending on
# whether XDG is available, or not
self.config_file_dir = os.path.abspath(self.script_parent_dir)
self.config_file_path = os.path.abspath(
os.path.join(self.script_parent_dir, self.config_file_name),
)
if not HAVE_XDG_FLAG:
self.config_file_xdg_dir = None
self.config_file_xdg_path = None
else:
self.config_file_xdg_dir = os.path.abspath(
os.path.join(
XDG_CONFIG_HOME,
__main__.__packagename__,
),
)
self.config_file_xdg_path = os.path.abspath(
os.path.join(
XDG_CONFIG_HOME,
__main__.__packagename__,
self.config_file_name,
),
)
# Name of the Tartube database file (storing media data). The database
# file is always found somewhere in self.data_dir
self.db_file_name = __main__.__packagename__ + '.db'
# Names of the database export files (for JSON, CSV and plain text)
self.export_json_file_name \
= __main__.__packagename__ + '_db_export.json'
self.export_csv_file_name \
= __main__.__packagename__ + '_db_export.csv'
self.export_text_file_name \
= __main__.__packagename__ + '_db_export.txt'
# The separator to use for CSV exports/imports. This will be escaped in
# regexes, so only values such as '|' and ',' should be used
self.export_csv_separator = '|'
# How Tartube should make backups of its database file:
# 'default' - make a backup file during a save procedure, but delete
# it when the save procedure is complete
# 'single' - make a backup file during a save procedure, replacing
# any existing backup file, and don't delete it when the save
# procedure is complete
# 'daily' - make a backup file once per day, the first time a save
# procedure is performed in that day. The file is labelled with
# the date, so backup files from previous days are not
# overwritten
# 'always' - always make a backup file, labelled with the date and
# time, so that no backup file is ever overwritten
self.db_backup_mode = 'always'
# If loading/saving of a config or database file fails, this flag is
# set to True, which disables all loading/saving for the rest of the
# session
# Exception: as of v2.3.555, a failure to save the database file no
# longer sets this flag to True
self.disable_load_save_flag = False
# ...but it does set this flag to True, preventing scheduled downloads
# from starting until the database has been successfully saved (or
# loaded)
self.disable_scheduled_dl_flag = False
# Optional error message generated when self.disable_load_save_flag
# was set to True
self.disable_load_save_msg = None
# If loading a database file (only) fails because of a lock file, this
# flag is set to True, so the user is prompted to remove the possibly
# stale lock file. If the user declines, the error message stored in
# self.disable_load_save_msg is then displayed
self.disable_load_save_lock_flag = False
# Users have reported that the Tartube database file was corrupted. On
# inspection, it was almost completely empty, presumably because
# self.save_db() had been called before .load_db()
# As the corruption was catastrophic, make sure that can never happen
# again with this flag, set to False until the code has either
# loaded a database file, or wants to call .save_db to create one
self.allow_db_save_flag = False
# Flag set to True if the Classic Mode tab should be the visible one,
# when Tartube first starts (for the benefit of users who only want
# Classic Mode downloads)
self.show_classic_tab_on_startup_flag = False
# Flag set to True if custom downloads are enabled in the Classic Mode
# tab
self.classic_custom_dl_flag = False
# Users can add more destination directories to the combobox in the
# Classic Mode tab. Tartube remembers those directories, up to the
# maximum number specified below
self.classic_dir_list = [ os.path.expanduser('~') ]
# The maximum size of the list. When a new directory is added by the
# user, it's moved to the top of the list. If the list is now too
# big, the last item is removed
self.classic_dir_max = 8
# The most recently-selected destination directory. On startup, if this
# directory still exists in self.classic_dir_list, it is moved to the
# top (and so it appears as the first item in the combobox). This IV
# is then reset
self.classic_dir_previous = None
# The selected format. If 'Default' is selected in the Classic Mode
# tab's combo, set to None
self.classic_format_selection = None
# Flag set to False, if videos should be downloaded in that format, or
# True if they should be converted to the format using FFmpeg/AVConv
self.classic_format_convert_flag = True
# The selected resolution. If 'Resolution' is selected in the Classic
# Mode tab's combo, set to None
self.classic_resolution_selection = None
# Flag set to True, if the URL should be treated as a broadcasting
# livestream
self.classic_livestream_flag = False
# Flag set to True, if pending URLs (still visible in the top half of
# the Classic Mode tab, or not yet downloaded in the bottom half)
# should be saved when Tartube shuts down, and restored (to the top
# half) when Tartube restarts
self.classic_pending_flag = False
# List of pending URLs. Set just before the config file is saved, and
# used just after it is loaded
self.classic_pending_list = []
# In the Classic Mode tab, when the user clicks the 'Add URLs' button,
# flag set to True if a duplicate URL (one which has already been
# added to the Classic Progress List), should be deleted from the
# textview at the top, rather than being retained
self.classic_duplicate_remove_flag = False
# The youtube-dl binary to use (platform-dependent) - 'youtube-dl' or
# 'youtube-dl.exe', depending on the platform. The default value is
# set by self.start()
self.ytdl_bin = None
# The default path to the youtube-dl binary. The value is set by
# self.start(). On MSWin, it is 'youtube-dl.exe'. On Linux, it is
# '/usr/bin/youtube-dl'
self.ytdl_path_default = None
# The path to the youtube-dl binary, after installation using PyPI.
# Not used on MS Windows. The initial ~ character must be substituted
# for os.path.expanduser('~'), before use
self.ytdl_path_pypi = '~/.local/bin/youtube-dl'
# The actual path to use in the shell command during a download or
# update operation. Initially given the same value as
# self.ytdl_path_default. After configurations, its value might be
# '/usr/bin/youtube-dl', '~/.local/bin/youtube-dl', just 'youtube-dl'
# or a custom path specified by the user
self.ytdl_path = None
# When the user has selected a custom path, this flag is set to True
# (even when that path is '/usr/bin/youtube-dl' or one of the other
# values listed above)
self.ytdl_path_custom_flag = False
# The shell command to use during an update operation depends on how
# youtube-dl was installed
# Depending on the operating system, Tartube provides some of these
# methods (listed here with the description visible to the user):
#
# 'ytdl_update_default_path'
# Update using default youtube-dl path
# 'ytdl_update_local_path'
# Update using local youtube-dl path
# 'ytdl_update_custom_path'
# Update using the path sepcified by self.ytdl_path
# 'ytdl_update_pip'
# Update using pip
# 'ytdl_update_pip_no_dependencies'
# Update using pip (use --no-dependencies option)
# 'ytdl_update_pip_omit_user'
# Update using pip (omit --user option)
# 'ytdl_update_pip3'
# Update using pip3
# 'ytdl_update_pip3_no_dependencies'
# Update using pip3 (use --no-dependencies option)
# 'ytdl_update_pip3_omit_user'
# Update using pip3 (omit --user option)
# 'ytdl_update_pip3_recommend'
# Update using pip3 (recommended)
# 'ytdl_update_pypi_path'
# Update using PyPI youtube-dl path
# 'ytdl_update_win_32',
# Windows 32-bit update (recommended)
# 'ytdl_update_win_32_no_dependencies',
# Windows 32-bit update (use --no-dependencies option)
# 'ytdl_update_win_64',
# Windows 64-bit update (recommended)
# 'ytdl_update_win_64_no_dependencies',
# Windows 64-bit update (use --no-dependencies option)
# 'ytdl_update_disabled'
# youtube-dl updates are disabled
# A dictionary containing some possibilities, populated by self.start()
# Dictionary in the form
# key: method name (one of those listed above)
# value: list of words to use in the shell command
self.ytdl_update_dict = {}
# A list of keys from self.ytdl_update_dict in a standard order (so the
# combobox in config.SystemPrefWin is in a standard order)
self.ytdl_update_list = []
# The user's choice of shell command; one of the keys in
# self.ytdl_update_dict, set by self.setup_paths()
self.ytdl_update_current = None
# Flag set to True if the Output tab should be revealed automatically
# during an update operation, and during some info operations
self.auto_switch_output_flag = True
# Maximum size of textviews in the Output tab
self.output_size_default = 1000
# (Absolute minimum and maximum values)
self.output_size_max = 10000
self.output_size_min = 1
# Flag set to True when the limit is actually applied, False when not
self.output_size_apply_flag = True
# Flag set to True if an update operation has succeeded at least once
# (the first time, we try to auto-detect youtube-dl's location)
self.ytdl_update_once_flag = False
# If specified the name of a youtube-dl fork to use, instead of the
# original youtube-dl. When specified, all system commands replace
# youtube-dl with this value
# If not specified, the value should be None (not an empty string).
# Ignored when self.ytdl_path_custom_flag is True
# (Tartube assumes that the fork is largely compatible with the
# original)
self.ytdl_fork = None
# Descriptions of various forks, used in the preference window and also
# in the wizard window
self.ytdl_fork_descrip_dict = {
'yt-dlp': \
'A popular fork of the original youtube-dl, created in 2020' \
+ ' by pukkandan. Officially supported by Tartube.',
'youtube-dl': \
'This is the original downloader, created by Ricardo Garcia' \
+ ' Gonzalez in 2006. Officially supported by Tartube.',
'custom': \
'Tartube may be compatible with other forks of youtube-dl.',
}
# v2.3.182: Currently, yt-dlp can't be installed on MS Windows under
# MSYS2, because the pycryptodome dependency can't be installed
# Flag set to True if yt-dlp (only), when installed via pip, should be
# installed without dependencies
if os.name == 'nt':
self.ytdl_fork_no_dependency_flag = True
else:
self.ytdl_fork_no_dependency_flag = False
# Flag set to True if youtube-dl system commands should be displayed in
# the Output tab
self.ytdl_output_system_cmd_flag = True
# Flag set to True if youtube-dl's STDOUT should be displayed in the
# Output tab
self.ytdl_output_stdout_flag = True
# Flag set to True if we should ignore JSON output when displaying text
# in the Output tab (ignored if self.ytdl_output_stdout_flag is
# False)
self.ytdl_output_ignore_json_flag = True
# Flag set to True if we should ignore download progress (as a
# percentage) when displaying text in the Output tab (ignored if
# self.ytdl_output_stdout_flag is False)
self.ytdl_output_ignore_progress_flag = True
# Flag set to True if youtube-dl's STDERR should be displayed in the
# Output tab
self.ytdl_output_stderr_flag = True
# Flag set to True if pages in the Output tab should be emptied at the
# start of each operation
self.ytdl_output_start_empty_flag = True
# Flag set to True if a summary page should be visible in the Output
# tab. Changes to this flag are applied when Tartube restarts
self.ytdl_output_show_summary_flag = False
# Flag set to True if youtube-dl system commands should be written to
# the terminal window
self.ytdl_write_system_cmd_flag = False
# Flag set to True if youtube-dl's STDOUT should be written to the
# terminal window
self.ytdl_write_stdout_flag = False
# Flag set to True if we should ignore JSON output when writing to the
# terminal window (ignored if self.ytdl_write_stdout_flag is False)
self.ytdl_write_ignore_json_flag = True
# Flag set to True if we should ignore download progress (as a
# percentage) when writing to the terminal window (ignored if
# self.ytdl_write_stdout_flag is False)
self.ytdl_write_ignore_progress_flag = True
# Flag set to True if youtube-dl's STDERR should be written to the
# terminal window
self.ytdl_write_stderr_flag = False
# Flag set to True if youtube-dl should show verbose output (using the
# --verbose option). The setting applies to both the Output tab and
# the terminal window
self.ytdl_write_verbose_flag = False
# Flag set to True if, during a refresh operation, videos should be
# displayed in the Output tab. Set to False if only channels,
# playlists and folders should be displayed there
self.refresh_output_videos_flag = True
# Flag set to True if, during a refresh operation, non-matching videos
# should be displayed in the Output tab. Set to False if only
# matching videos should be displayed there. Ignore if
# self.refresh_output_videos_flag is False
self.refresh_output_verbose_flag = False
# The moviepy module hangs indefinitely, if it is used to open a
# corrupted video file
# (see https://github.com/Zulko/moviepy/issues/639)
# To counter this, self.update_video_from_filesystem() moves the
# procedure into a thread, and applies a timeout to that thread
# The timeout (in seconds) to apply. Must be an integer, 0 or above.
# If 0, the moviepy procedure is allowed to hang indefinitely
self.refresh_moviepy_timeout = 10
# Paths to the post-processor binaries. If neither is set, we assume
# that FFmpeg and AVConv are in the user's path. If one is set to any
# value besides None, it is passed to youtube-dl. If both are set,
# then one of them is passed to youtube-dl: AVConv if the download
# option 'prefer_avconv' applies, FFmpeg if not
# None of these values are used on MS Windows
# Default path to the FFmpeg binary
self.default_ffmpeg_path = '/usr/bin/ffmpeg'
# Path to the FFmpeg binary
self.ffmpeg_path = None
# Default path to the AVConv binary
self.default_avconv_path = '/usr/local/bin/avconv'
# Path to the AVConv binary
self.avconv_path = None
# Flag set to True when a call to FFmpegManager.convert_webp() fails,
# indicating that FFmpeg is not installed on the user's system
# When True, the code will not attempt to convert any more .webp
# thumbnails to .jpg (until the user restarts Tartube)
self.ffmpeg_fail_flag = False
# The system error message to display when failure occurs (used
# several times, so defined here)
self.ffmpeg_fail_msg = _(
'Failed to convert a thumbnail from .webp to .jpg. No more' \
+ ' conversions will be attempted until you install FFmpeg on' \
+ ' your system, or (if FFmpeg is already installed) you set the' \
+ ' correct FFmpeg path. To attempt more conversions, restart' \
+ ' Tartube. To stop these messages, disable thumbnail' \
+ ' conversions',
)
# Flag set to True if Tartube should attempt to convert .webp
# thumbnails (from YouTube), which can't be displayed in the main
# window, into .jpg thumbnails, which can be displayed
# Ignored if self.ffmpeg_fail_flag is True
self.ffmpeg_convert_webp_flag = True
# Mode for downloading broadcasting livestreams:
# 'default' - use the current downloader alone. This normally works
# with yt-dlp, probably not with youtube-dl
# 'default_m3u' - use the current downloader to fetch the .m3u
# manifest, then FFmpeg to download the livestream. Requires
# FFmpeg
# 'streamlink' - use streamlink (if installed on the user's system)
self.livestream_dl_mode = 'default_m3u'
# Settings for downloading broadcasting livestreams
# Timeout (in minutes) during livestream downloads (minimum value 1,
# fractional numbers are allowed)
self.livestream_dl_timeout = 3
# If True, resume an earlier download. If False, replace the earlier
# download. When using streamlink, the earlier download is always
# replaced
self.livestream_replace_flag = True
# When a download is stopped (for example, when the user clicks the
# main window's 'Stop' button), mark the download as finished when
# this flag is True
self.livestream_stop_is_final_flag = True
# If True, check the media.Video object before downloading the
# livestream (which ensures the thumbnail and other metadata files
# are downloaded)
self.livestream_force_check_flag = True
# Path to the streamlink binary. If not set, we assume that streamlink
# is in the user's path
self.streamlink_path = None
# During a download operation, a GObject timer runs, so that the
# Progress tab and Output tab can be updated at regular intervals
# There is also a delay between the instant at which youtube-dl
# reports a video file has been downloaded, and the instant at which
# it appears in the filesystem. The timer checks for newly-existing
# files at regular intervals, too
# The timer's ID (None when no timer is running)
self.dl_timer_id = None
# The timer interval time (in milliseconds)
self.dl_timer_time = 500
# At the end of the download operation, the timer continues running for
# a few seconds, to give new files a chance to appear in the
# filesystem. The maximum time to wait (in seconds)
self.dl_timer_final_time = 5
# Once that extra time has been applied, the time (matches time.time())
# at which to stop waiting
self.dl_timer_check_time = None
# During a download operation, we periodically check whether the device
# containing self.data_dir is running out of space
# The check interval time (in seconds)
self.dl_timer_disk_space_time = 60
# The time (matchs time.time()) at which the next check takes place
self.dl_timer_disk_space_check_time = None
# Flag set to True if Tartube should warn if the system is running out
# of disk space (on the drive containing self.data_dir), False if
# not. The warning is issued at the start of a download operation
self.disk_space_warn_flag = True
# The amount of free disk space (in Gb) below which the warning is
# issued. If 0, no warning is issued. Ignored if
# self.disk_space_warn_flag is False
self.disk_space_warn_limit = 1
# Flag set to True if Tartube should refuse to start a download
# operation, and halt an existing download operation, if the system
# is running out of disk space (on the drive containing
# self.data_dir), False if not
self.disk_space_stop_flag = True
# The amount of free disk space (in Gb) below which the refusal/halt
# is enacted. If 0, a download operation will continue downloading
# files until the device actually runs out of space. Ignored if
# self.disk_space_stop_flag is False
self.disk_space_stop_limit = 0.5
# The IVs above can be set to any number (0 or above), but the
# Gtk.SpinButtons in the system preferences window increment/
# decrement the value by this many Gb at a time
self.disk_space_increment = 0.1
# An absolute minimum of disk space, below which a download operation
# will not start, or will halt, regardless of the values of the IVs
# above (in Gb)
self.disk_space_abs_limit = 0.05
# Default invidio.us mirror to use (the original site closed in
# September 2020); this value never changes
self.default_invidious_mirror = 'yewtu.be'
# Custom mirror to use (can be set by the user)
self.custom_invidious_mirror = self.default_invidious_mirror
# Default SponsorBlock API mirror to use (this value never changes)
self.default_sblock_mirror = 'sponsor.ajay.app/api'
# Custom mirror to use (can be set by the user)
self.custom_sblock_mirror = self.default_sblock_mirror
# Custom download operation settings
# A downloads.CustomDLManager object specifies settings to use during a
# custom download
# Each CustomDLManager has a unique .uid IV (unique only to this class
# of objects), and a non-unique name (in case the user wants to
# import settings, which might have a duplicate name)
# The number of downloads.CustomDLManager objects ever created
# (including any that have been deleted), used to generate the unique
# .uid
self.custom_dl_reg_count = 0
# A dictionary containing all downloads.CustomDLManager objects (but
# not those which have been deleted)
# Dictionary in the form
# key = object's unique .uid
# value = the custom download manager object itself
self.custom_dl_reg_dict = {}
# The General Custom Download Manager, used as the default manager
self.general_custom_dl_obj = None
# The downloads.CustomDLManager object used in the Classic Mode tab. If
# None, then self.general_custom_dl_obj is used
self.classic_custom_dl_obj = None
# List of proxies. If set, a download operation cycles between them.
# Does not apply to streamlink downloads
self.dl_proxy_list = []
# At the start of a download operation, the contents of
# self.dl_proxy_list are copied into this list. Whenever a proxy is
# required, the first item in the list is used, and moved to the
# bottom of the list
self.dl_proxy_cycle_list = []
# During an update operation, a separate GObject timer runs, so that
# the Output tab can be updated at regular intervals
# The timer's ID (None when no timer is running)
self.update_timer_id = None
# The timer interval time (in milliseconds)
self.update_timer_time = 500
# At the end of the update operation, the timer continues running for
# a few seconds, to prevent various Gtk errors (and occasionally
# crashes) for systems with Gtk < 3.24. The maximum time to wait (in
# seconds)
self.update_timer_final_time = 3
# Once that extra time has been applied, the time (matches time.time())
# at which to stop waiting
self.update_timer_check_time = None
# During a refresh operation, a separate GObject timer runs, so that
# the Output tab can be updated at regular intervals
# The timer's ID (None when no timer is running)
self.refresh_timer_id = None
# The timer interval time (in milliseconds)
self.refresh_timer_time = 500
# At the end of the refresh operation, the timer continues running for
# a few seconds, to prevent various Gtk errors (and occasionally
# crashes) for systems with Gtk < 3.24. The maximum time to wait (in
# seconds)
self.refresh_timer_final_time = 2
# Once that extra time has been applied, the time (matches time.time())
# at which to stop waiting
self.refresh_timer_check_time = None
# During an info operation, a separate GObject timer runs, so that
# the Output tab can be updated at regular intervals
# The timer's ID (None when no timer is running)
self.info_timer_id = None
# The timer interval time (in milliseconds)
self.info_timer_time = 500
# At the end of the info operation, the timer continues running for
# a few seconds, to prevent various Gtk errors (and occasionally
# crashes) for systems with Gtk < 3.24. The maximum time to wait (in
# seconds)
# (Shorter wait time than other operations, because this type of
# operation finishes quickly)
self.info_timer_final_time = 2
# Once that extra time has been applied, the time (matches time.time())
# at which to stop waiting
self.info_timer_check_time = None
# During a tidy operation, a separate GObject timer runs, so that
# the Output tab can be updated at regular intervals
# The timer's ID (None when no timer is running)
self.tidy_timer_id = None
# The timer interval time (in milliseconds)
self.tidy_timer_time = 500
# At the end of the tidy operation, the timer continues running for
# a few seconds, to prevent various Gtk errors (and occasionally
# crashes) for systems with Gtk < 3.24. The maximum time to wait (in
# seconds)
# (Shorter wait time than other operations, because this type of
# operation might finish quickly)
self.tidy_timer_final_time = 2
# Once that extra time has been applied, the time (matches time.time())
# at which to stop waiting
self.tidy_timer_check_time = None
# During a process operation, a separate GObject timer runs, so that
# the Output tab can be updated at regular intervals
# The timer's ID (None when no timer is running)
self.process_timer_id = None
# The timer interval time (in milliseconds)
self.process_timer_time = 500
# At the end of most operations, the timer continues running for a few
# seconds, to prevent various Gtk errors. There are no such issues
# with a process operation, so the wait time is only 1
self.process_timer_final_time = 1
# Once that extra time has been applied, the time (matches time.time())
# at which to stop waiting
self.process_timer_check_time = None
# During any operation (except livestream operations), a flag set to
# True if the operation was halted by the user, rather than being
# allowed to complete naturally
self.operation_halted_flag = False
# During a download operation, a flag set to True if Tartube must shut
# down when the operation is finished
self.halt_after_operation_flag = False
# During a download operation, a flag set to True if no dialogue
# window must be shown at the end of that operation (but not
# necessarily any future download operations)
self.no_dialogue_this_time_flag = False
# For a channel/playlist containing hundreds (or more!) videos, a
# download operation will take a very long time, even though we might
# only want to check for new videos
# Flag set to True if the download operation should give up checking a
# channel or playlist when its starts receiving details of videos
# about which it already knows (from a previous download operation)
# This works well if the website sends video in order, youngest first
# (as YouTube does), but won't work at all otherwise
self.operation_limit_flag = False
# During simulated video downloads (e.g. after clicking the 'Check all'
# button), stop checking the channel/playlist after receiving details
# for this many videos, when a media.Video object exists for them
# and the object's .file_name and .name IVs are set
# Must be an positive integer or 0. If 0, no limit applies. Ignored if
# self.operation_limit_flag is False
self.operation_check_limit = 3
# During actual video downloads (e.g. after clicking the 'Download all'
# button), stop downloading the channel/playlist after receiving
# this many 'video already downloaded' messages, when a media.Video
# objects exists for them and the object's .dl_flag is set
# Must be an positive integer or 0. If 0, no limit applies. Ignored if
# self.operation_limit_flag is False
self.operation_download_limit = 3
# Flag set to True if the newbie dialogue should appear after a failed
# download operation, explaining what to do
self.show_newbie_dialogue_flag = True
# Flag set to True if a dialogue should appear when the user opens the
# MSYS2 terminal from the main menu (on MS Windows only; ignored on
# other systems)
self.show_msys2_dialogue_flag = True
# Flag set to True if a dialogue should appear when deleting video(s)
# from within the Video Catalogue's popup menu
self.show_delete_video_dialogue_flag = True
# Default setting for this dialogue: True to delete files, False to
# just remove the video(s) from the database
self.delete_video_files_flag = False
# Flag set to True if a dialogue should appear when deleting a channel,
# playlist or folder from withint the Video Index's popup menu
self.show_delete_container_dialogue_flag = True
# Default setting for this dialogue: True to delete files, False to
# just remove the container and its videos from the database
self.delete_container_files_flag = False
# Media data classes are those specified in media.py. Those class
# objects are media.Video (for individual videos), media.Channel,
# media.Playlist and media.Folder (reprenting a sub-directory inside
# Tartube's data directory)
# Some media data objects have a list of children which are themselves
# media data objects. In that way, the user can organise their videos
# in convenient folders
# media.Folder objects can have any media data objects as their
# children (including other media.Folder objects). media.Channel and
# media.Playlist objects can have media.Video objects as their
# children. media.Video objects don't have any children
#
# The media data registry
# Every media data object has a unique .dbid (which is an integer). The
# number of media data objects ever created (including any that have
# been deleted), used to give new media data objects their .dbid
self.media_reg_count = 0
# A dictionary containing all media data objects (but not those which
# have been deleted)
# Dictionary in the form
# key = media data object's unique .dbid
# value = the media data object itself
self.media_reg_dict = {}
# media.Channel, media.Playlist and media.Folder objects must have
# unique .name IVs
# (A channel and a playlist can't have the same name. Videos within a
# single channel, playlist or folder can't have the same name.
# Videos with different parent objects CAN have the same name)
# A dictionary used to check that media.Channel, media.Playlist and
# media.Folder objects have unique .name IVs (and to look up names
# quickly)
# Dictionary in the form
# key = media data object's .name
# value = media data object's unique .dbid
self.media_name_dict = {}
# media.Channel, media.Playlist and media.Folder objects can have an
# external directory set (i.e. videos are downloaded outside of
# Tartube's data directory)
# When the database is loaded, we check the semaphore file in each
# external directory. Any from which we can't write or read
# (indicating that the location is not available on the user's
# filesystem) are added to this dictionary. Entries can be removed
# from the dictionary when the channel/playlist/folder's external
# directory is modified (or reset), or otherwise when a new database
# is loaded
# Channels/playlists/folders added to this dictionary cannot be
# checked/downloaded/custom downloaded
# Dictionary in the form
# key = media data object's .name
# value = media data object's unique .dbid
self.media_unavailable_dict = {}
# An ordered list of media.Channel, media.Playlist and media.Folder
# objects which have no parents (in the order they're displayed)
# This list, combined with each media data object's child list, is
# used to construct a family tree. A typical family tree looks
# something like this:
# Folder
# Channel
# Video
# Video
# Channel
# Video
# Video
# Folder
# Folder
# Playlist
# Video
# Video
# Folder
# Playlist
# Video
# Video
# Folder
# Video
# Video
# A list of .dbid IVs for all top-level media.Channel, media.Playlist
# and media.Folder objects
self.media_top_level_list = []
# The maximum depth of the media registry. The diagram above shows
# channels on the 2nd level and playlists on the third level.
# Container objects cannot be added beyond the following level
self.media_max_level = 8
# Standard name for a media.Video object, when the actual name of the
# video is not yet known
self.default_video_name = '(video with no name)'
# The maximum length of channel, playlist and folder names (does not
# apply to video names)
self.container_name_max_len = 64
# Forbidden names for channels, playlists and folders. This is to
# prevent the user overwriting directories in self.data_dir, that
# Tartube uses for its own purposes, and to prevent the user fooling
# Tartube into thinking that the old file structure is being used
# Every item in this list is a regex; a name for a channel, playlist
# or folder must not match any item in the list. (media.Video
# objects can still have any name)
self.illegal_name_regex_list = [
r'^\.',
r'^downloads$',
__main__.__packagename__,
]
# Extended list of forbidden names for channels, playlists and folders
# (on MS Windows). Each item is still illegal if followed by a file
# extension, e.g. 'LPT1.txt'
self.illegal_name_mswin_list = [
'CON', 'PRN', 'AUX', 'NUL',
'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8',
'COM9',
'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8',
'LPT9',
]
# Temporary dictionary of channel/playlist names extracted from the
# child video's metadata. The user can use this dictionary to
# update channel/playlists names (for example, if they have been
# given a generic name like 'channel_1')
# The dictionary is reset and then updated during a download operation
# (real or simulated). A key-value pair for a channel/playlist is
# added if:
# - At least one video was checked or downloaded, and its
# metadata was extracted
# - The channel/playlist name, according to the metadata, is
# different from the name of the media.Channel/media.Playlist
# object
# Note that once a key-value pair is added for a channel/playlist, it
# is not updated again during a download operation (so if several
# child videos supply different channel/playlist names, only the
# first one is used)
# Dictionary in the form
# key = media data object's .dbid
# value = the channel/playlist name extracted from the child video
# metadata
self.media_reset_container_dict = {}
# A subset of self.media_reg_dict, containing only media.Videos which
# are marked as livestreams (and which must therefore be checked by
# livestream operations)
self.media_reg_live_dict = {}
# A subset of self.media_reg_live_dict, containing only media.Videos
# which are waiting live streams. When the livestream goes live, a
# desktop notification is shown for them
self.media_reg_auto_notify_dict = {}
# A subset of self.media_reg_live_dict, containing only media.Videos
# which are waiting live streams. When the livestream goes live, an
# alarm is sounded for them
self.media_reg_auto_alarm_dict = {}
# A subset of self.media_reg_live_dict, containing only media.Videos
# which are waiting live streams. When the livestream goes live, the
# video is opened in the system's web browser
self.media_reg_auto_open_dict = {}
# A subset of self.media_reg_live_dict, containing only media.Videos
# which should be downloaded, as soon as they start (as soon as this
# is processed, the entry is removed from the dictionary)
self.media_reg_auto_dl_start_dict = {}
# A subset of self.media_reg_live_dict, containing only media.Videos
# which should be downloaded, as soon as they stop (as soon as this
# is processed, the entry is removed from the dictionary)
self.media_reg_auto_dl_stop_dict = {}
# Some media data objects are fixed (i.e. are created when Tartube
# first starts, and cannot be deleted by the user). Shortcuts to
# those objects
# Private folder containing all videos (users cannot add anything to a
# private folder, because it's used by Tartube for special purposes)
self.fixed_all_folder = None
# Private folder containing only bookmarked videos
self.fixed_bookmark_folder = None
# Private folder containing only favourite videos
self.fixed_fav_folder = None
# Private folder containing only videos marked as (waiting or
# broadcasting) livestreams
self.fixed_live_folder = None
# Private folder containing only videos that have been removed from
# a channel/playlist (by the creator); only updated when
# self.track_missing_videos_flag is enabled
self.fixed_missing_folder = None
# Private folder containing only new videos
self.fixed_new_folder = None
# Private folder containing only videos from the most recent download
# operation. The folder is emptied at the start of every new
# download operation
self.fixed_recent_folder = None
# Private folder containing only playlist videos (when the user
# watches one, online or locally, the video is removed from the
# playlist)
self.fixed_waiting_folder = None
# Public folder that's used as the second one in the 'Add video'
# dialogue window, in which the user can store any individual videos
# that are automatically deleted when Tartube shuts down
self.fixed_temp_folder = None
# Public folder that's used as the first one in the 'Add video'
# dialogue window, in which the user can store any individual videos
self.fixed_misc_folder = None
# Public folder that's used for storing video clips (optionally)
self.fixed_clips_folder = None
# The locale for which the fixed folders are named. When the database
# file is loaded, if this value no longer matches self.custom_locale,
# then the folder names are all updated for the new locale
self.fixed_folder_locale = self.custom_locale
# For the Recent Videos folder (self.fixed_recent_folder), the time
# (in days) after which videos should be removed. If 0, videos are
# removed at the start of every download operation
self.fixed_recent_folder_days = 0
# A list of media.Video objects the user wants to watch, as soon as
# they have been downloaded. Videos are added by a call to
# self.watch_after_dl_list(), and removed by a call to
# self.announce_video_download()
self.watch_after_dl_list = []
# The edit/preference windows can draw graphs. The format of the graphs
# are specified by five standard comboboxes (specified in
# config.GenericConfigWin.add_combos_for_graphs() ), and those
# specifications are remembered between windows
# The data type ('receive' for download times, 'upload' for upload
# times, 'size' for file size, 'duration' for video duration)
self.graph_data_type = 'receive'
# The type of graph to plot ('graph' for a line plot graph, or 'chart'
# for a bar chart)
self.graph_plot_type = 'graph'
# The period of time used as the span of the x-axis (in seconds, e.g.
# 31536000 is the equivalent of a year)
self.graph_time_period_secs = 60*60*24*365
# The time unit to use (in seconds, e.g. 604800 is the equivalent of a
# week). We count the number of videos for the time unit and use it
# as a single point on the x-axis
self.graph_time_unit_secs = 60*60*24*30
# The colour to use ('red', 'green', 'blue', 'black', white')
self.graph_ink_colour = 'blue'
# Scheduled downloads
# The user can create as many scheduled downloads as they want (this is
# a change from earlier versions, in which only one of each type of
# scheduled download could be created)
# Each scheduled download is represented by a media.Scheduled object.
# The objects are stored in the database file
# A list of media.Scheduled objects. When deciding whether to start a
# scheduled download, the objects are checked in this order
self.scheduled_list = []
# Profiles
# Items in the Video Index can be marked (using their checkboxes). When
# at least one item is marked, the 'Check all' and 'Download all'
# buttons become 'Check marked items' and 'Download marked items'
# A profile is a list of .dbids for marked items, so the user can
# switch between them
# Dictionary in the form
# key = unique name for the profile
# value = list of .dbdis for media.Channel, media.Playlist and
# media.Folder items
self.profile_dict = {}
# The profile which was most recently created, or to which the user
# most recently switched. Reset when that profile is deleted
self.last_profile = None
# Flag set to True if Tartube should automatically switch to that
# profile, when the database is loaded
self.auto_switch_profile_flag = False
# Maximum number of profiles (a constant value)
self.profile_max = 16
# Download Options and Options Managers
# During a download operation, youtube-dl is supplied with a set of
# download options. Those options are specified by an
# options.OptionsManager object
# Each media data object may have its own options.OptionsManager
# object. If not, it uses the options.OptionsManager object of its
# parent (or of its parent's parent, and so on)
# If this chain of family relationships doesn't provide an
# options.OptionsManager object, then this default object, known as
# the General Options Manager, is used
# Every options.OptionsManager object has a unique .uid IV, and a non-
# unique name (because, for example, a video might have the same
# name as a channel; it's up to the user to avoid duplicate names)
# The number of options.OptionsManager objects ever created (including
# any that have been deleted), used to generate the unique .uid
self.options_reg_count = 0
# A dictionary containing all options.OptionsManager objects (but not
# those which have been deleted)
# Dictionary in the form
# key = object's unique .uid
# value = the options manager object itself
self.options_reg_dict = {}
# The general (default) options.OptionsManager object described above
self.general_options_obj = None
# The options.OptionsManager object used in the Classic Mode tab. If
# None, then self.general_options_obj is used
self.classic_options_obj = None
# An ordered list of options.OptionsManager .uids, used in the
# Drag and Drop tab. The list does not have to contain every (or
# even any) items, but there must be no duplicates
# Maximum size is 16 (any more items are ignored)
self.classic_dropzone_list = []
# Flag set to True if the General Options Manager
# (self.general_options_obj) should be cloned whenever the user
# applies a new options manager to a media data object (e.g. by
# right-clicking a channel in the Video Index, and selecting
# Downloads > Apply options manager)
self.auto_clone_options_flag = True
# Flag set to True if options applied to a media.Video object should be
# deleted, once the video has been downloaded
self.auto_delete_options_flag = True
# Flag set to True if a smaller set of options should be shown in the
# download options edit window (for inexperienced users)
self.simple_options_flag = True
# FFmpeg options manager
# We can pass a list of video(s) directly to the process operation,
# using a custom set of FFmpeg command line options
# Each individual set is stored in an
# ffmpeg_tartube.FFmpegOptionsManager object
# Each options manager has a unique .uid IV (unique only to this class
# of objects; the number range is not shared with
# options.OptionsManager objects), and a non-unique name (in case the
# user wants to import a set of options, which might have a duplicate
# name)
# The number of ffmpeg_tartube.FFmpegOptionsManager objects ever
# created (including any that have been deleted), used to generate
# the unique .uid
self.ffmpeg_reg_count = 0
# A dictionary containing all ffmpeg_tartube.FFmpegOptionsManager
# objects (but not those which have been deleted)
# Dictionary in the form
# key = object's unique .uid
# value = the FFmpeg options manager object itself
self.ffmpeg_reg_dict = {}
# Of all the objects, only one is in use at any time. The current
# FFmpeg options manager
self.ffmpeg_options_obj = None
# Flag set to True if the edit window should use a GUI layout adapted
# from FFmpeg command line wizard by AndreKR. If False, a minimal
# layout is used, and the user must specify most of the FFmpeg
# command line options manually
self.ffmpeg_simple_options_flag = True
# Flag set to True if checking/downloading livestreams should be
# blocked by yt-dlp (does not work with other downloaders)
self.block_livestreams_flag = False
# Flag set to True if Tartube should try to detect livestreams (on
# compatible websites only)
# This feature is only tested on YouTube. It might work on other
# websites, if the user has set the RSS feed for each channel/
# playlist individually
# If enabled, the download operation checks a channel/playlist RSS for
# videos that weren't picked up by ytdl, and marks them as
# livestreams. If JSON data can't be downloaded from it, assume it's
# an upcoming livestream; otherwise assume the livestream is live
self.enable_livestreams_flag = True
# If enabled, Tartube will assume that the website lists videos in
# order of announcement time, and will stop checking the RSS feed
# when it finds videos which are at least this old (in days). If set
# to zero, Tartube stops checking the RSS feed when it finds the
# first non-livestream video
self.livestream_max_days = 7
# Flag set to True if livestream videos in the Video Catalogue should
# be drawn with a coloured background, False if not
self.livestream_use_colour_flag = True
# Flag set to True if background colours should be the same for debut
# and livestream videos, False if four separate background colours
# should be used (ignored if self.livestream_use_colour_flag os
# False)
self.livestream_simple_colour_flag = False
# Flag set to True if a desktop notification should be shown when a
# waiting livestream goes live (the setting can then be enabled/
# disabled for each video individually in the Video Catalogue)
self.livestream_auto_notify_flag = False
# Flag set to True if a Tartube should play an alarm when a waiting
# livestream goes live (the setting can then be enabled/disabled for
# each video individually in the Video Catalogue)
self.livestream_auto_alarm_flag = False
# Flag set to True if a video should be opened in the system's web
# browser when it goes live (the setting can then be enabled/
# disabled for each video individually in the Video Catalogue)
self.livestream_auto_open_flag = False
# Flag set to True if a video should be downloaded as soon as the
# livestream starts (media.Video.live_mode was 0/1, set to 2; the
# setting can then be enabled/disabled for each video individually in
# the Video Catalogue)
# The start of the download may be delayed if a download operation is
# already in progress
self.livestream_auto_dl_start_flag = False
# Flag set to True if a video should be downloaded as soon as the
# livestream stops (media.Video.live_mode was 2, set to 0; the
# setting can then be enabled/disabled for each video individually in
# the Video Catalogue)
# The start of the download may be delayed if a download operation is
# already in progress
# If both this flag and self.livestream_auto_dl_start_flag are set to
# True, then youtube-dl is instructed to overwrite the earlier file
# (NB As of April 2020, this is still not possible; as a temporary
# measure, the earlier file is renamed instead)
self.livestream_auto_dl_stop_flag = False
# The livestream operation can run periodically and checks the
# status of videos marked as livestreams
# Flag set to True if the livestream task should run periodically
self.scheduled_livestream_flag = True
# The time (in minutes) between scheduled livestream operations, if
# enabled (cannot be fractional, minimum value 1)
self.scheduled_livestream_wait_mins = 3
# The time (system time, in seconds) at which the last livestream
# operation started
self.scheduled_livestream_last_time = 0
# Flag set to True if livestream operations should be performed at
# least every minute, when any livestream is due to start
self.scheduled_livestream_extra_flag = True
# Flag set to True if a download operation should auto-stop after a
# certain period of time (applies to both real and simulated
# downloads)
self.autostop_time_flag = False
# Auto-stop after this amount of time (minimum value 1)...
self.autostop_time_value = 1
# ...in this many units (any of the values in
# formats.TIME_METRIC_LIST)
self.autostop_time_unit = 'hours'
# Flag set to True if a download operation should auto-stop after a
# certain number of videos (applies to both real and simulated
# downloads)
self.autostop_videos_flag = False
# Auto-stop after this many videos (minimum value 1)
self.autostop_videos_value = 100
# Flag set to True if a download operation should auto-stop after
# downloading videos of a certain combined size (applies to real
# downloads only; the specified size is approximate, because it
# relies on the video size reported by youtube-dl, and doesn't take
# account of thumbnails, JSON data, and so on)
self.autostop_size_flag = False
# Auto-stop after this amount of diskspace (minimum value 1)...
self.autostop_size_value = 1
# ...in this many units (any of the values in
# formats.FILESIZE_METRIC_LIST)
self.autostop_size_unit = 'GiB'
# Flag set to True if an update operation should be automatically
# started before the beginning of every download operation
self.operation_auto_update_flag = False
# When that flag is True, the following IVs are set by the initial
# call to self.download_manager_start(), reminding
# self.update_manager_finished() to start a download operation, and
# supplying it with the arguments from the original call to
# self.download_manager_start()
self.operation_waiting_flag = False
self.operation_waiting_type = None
self.operation_waiting_list = []
self.operation_waiting_obj = None
# Flag set to True if files should be saved at the end of every
# operation
self.operation_save_flag = True
# Flag set to True if, during download operations using simulated
# downloads, videos whose parent is a media.Folder (i.e. videos not
# in channels/playlists) should not be added to the downlist list,
# unless (1) the location of the video file is not set and no
# thumbnail has been downloaded, or (2) the video is passed directly
# to the download operation (for example, by right-clicking a video
# and selecting 'Check Video' in the popup menu). If False, those
# videos are always added to the download list
# (This does not affect real downloads, in which such videos are never
# added to the download list)
self.operation_sim_shortcut_flag = True
# Flag set to True if, during download operations (of all kinds), if a
# job stalls, it should be restarted
self.operation_auto_restart_flag = False
# When youtube-dl reports network problems, how many minutes should
# Tartube wait before restarting the job (minimum value is 1,
# ignore if self.operation_auto_restart_flag is not set)
self.operation_auto_restart_time = 2
# The maximum number of times to restart a stalled job. If 0, no
# maximum applies. Ignored ignored if
# self.operation_sim_shortcut_flag is not set)
self.operation_auto_restart_max = 5
# How to notify the user at the end of each download/update/refresh
# operation: 'dialogue' to use a dialogue window, 'desktop' to use a
# desktop notification, or 'default' to do neither
# NB Desktop notifications don't work on MS Windows
self.operation_dialogue_mode = 'dialogue'
# What to do when the user creates a media.Video object whose URL
# represents a channel or playlist
# 'channel' to create a new media.Channel object, and place all the
# downloaded videos inside it (the original media.Video object is
# destroyed)
# 'playlist' to create a new media.Playlist object, and place all the
# downloaded videos inside it (the original media.Video object is
# destroyed)
# 'multi' to create a new media.Video object for each downloaded video,
# placed in the same folder as the original media.Video object (the
# original is destroyed)
# 'disable' to download nothing from the URL
# There are some restrictions. If the original media.Video object is
# contained in a folder whose .restrict_mode is not 'open', and if
# the mode is 'channel' or 'playlist', then the new channel/playlist
# is not created in that folder. If the original media.Video object
# is contained in a channel or playlist, all modes to default to
# 'disable'
# For downloads launched from the Classic Mode tab, none of this
# applies. Tartube downloads all videos associated with the URLs,
# and doesn't much care if the URLs represent channels and playlists
# or not
self.operation_convert_mode = 'channel'
# Flag set to True if self.update_video_from_filesystem() should get
# the video duration, if not already known, using the moviepy.editor
# module (an optional dependency)
self.use_module_moviepy_flag = True
# Flag set to True if dialogue windows for adding videos, channels and
# playlists should copy the contents of the system clipboard
self.dialogue_copy_clipboard_flag = True
# Flag set to True if dialogue windows for adding channels and
# playlists should continually re-open, whenever the use clicks the
# OK button (so multiple channels etc can be added quickly)
self.dialogue_keep_open_flag = False
# Flag set to True is, when adding a YouTube channel and the URL
# doesn't end with .../videos, the user should be prompted to add it
self.dialogue_yt_remind_flag = True
# On Virtualbox MSWin installations, dialogue windows can freeze
# Tartube, forcing a restart. Flag set to True if message dialogue
# windows (only) should be disabled, their messages being displayed
# in the terminal instead
self.dialogue_disable_msg_flag = False
# Standard name for the youtube-dl archive file (cannot be changed by
# the user)
self.ytdl_archive_name = 'ytdl-archive.txt'
# Flag set to True if, when downloading videos, youtube-dl should be
# passed the download option '--download-archive', creating an
# archive file
# If the file exists, youtube-dl won't re-download a video a user has
# deleted
# Ignored for system folders like 'Unsorted Videos'
self.allow_ytdl_archive_flag = True
# The location of the archive file: 'default' to place it in the same
# directory as the video, 'top' to place it in self.data_dir, or
# 'custom'
self.allow_ytdl_archive_mode = 'default'
# When 'custom', the full path to the directory in which the archive
# file is stored (if no path set, we behave as if
# self.allow_ytdl_archive_mode was 'default')
self.allow_ytdl_archive_path = None
# Flag set to True if an archive file should be created when
# downloading from the Classic Mode tab (this is marked 'not
# recommended' in the edit window)
self.classic_ytdl_archive_flag = False
# Flag set to True if, when checking videos/channels/playlists, we
# should apply a timeout (in case youtube-dl gets stuck downloading
# the JSON data)
self.apply_json_timeout_flag = True
# The length of the timeouts to apply, in minutes, when not fetching
# comments (self.check_comment_fetch_flag and
# self.dl_comment_fetch_flag are both False)
self.json_timeout_no_comments_time = 2
# The length of the timeouts to apply, in minutes, when fetching
# comments (self.check_comment_fetch_flag and/or
# self.dl_comment_fetch_flag are True)
self.json_timeout_with_comments_time = 5
# Flag set to True if, when checking/downloading channels/playlists,
# we should look out for previously-downloaded videos (that the
# creator has since removed from their channel/playlist), and add
# them to the system 'Missing videos' folder
self.track_missing_videos_flag = False
# Flag set to True if a time limit should be placed on missing videos.
# Ignored if self.track_missing_videos_flag is False
self.track_missing_time_flag = False
# The time limit (in days) to apply. If videos will only be marked as
# missing if uploaded within this many days. If set to 0, no videos
# are marked as missing. Ignored if self.track_missing_videos_flag or
# self.track_missing_time_flag is False
self.track_missing_time_days = 14
# Flag set to True if, during a real (not simulated) download,
# youtube-dl error/warning messages without a video ID (which is, at
# the time of writing, most of them) should be assigned to the most
# probable media.Video object; False if anonymous messages should be
# assigned to the parent channel/playlist/folder instead
# (Assigning anonymous messages to videos is not an exact science, but
# should work well enough for most users)
self.auto_assign_errors_warnings_flag = True
# Flag set to True if, during a download operation, videos marked as
# being censored, age-restricted or otherwise unavailable for
# download should be added to the database
self.add_blocked_videos_flag = True
# Flag set to True if Tartube should retrieve the playlist ID from each
# checked/downloaded video's metadata, and store it in the parent
# channel/playlist
# (For 'enhanced' websites specified by formats.ENHANCED_SITE_DICT,
# the user can use the collected IDs to get a list of playlists
# associated with a channel)
self.store_playlist_id_flag = True
# Flag set to True if a list of timestamps should be extracted from a
# video's .info.json file, when it is received
self.video_timestamps_extract_json_flag = False
# Flag set to True if a list of timestamps should be extracted from a
# video's description file, when it is received
self.video_timestamps_extract_descrip_flag = False
# Flag set to True if the previous set of timestamps should be
# replaced, when a video is checked/downloaded
self.video_timestamps_replace_flag = False
# Flag set to True if, just before trying to split a video based on its
# timestamps, downloads.ClipDownloader and process.ProcessManager
# should try to re-extract the timestamps from the metadata or
# description files (if none have been extracted so far)
self.video_timestamps_re_extract_flag = False
# When splitting videos, the format for the name of the video clips:
# num Number
# clip Clip Title
# num_clip Number + Clip Title
# clip_num Clip Title + Number
# orig Original Title
# orig_num Original Title + Number
# orig_clip Original Title + Clip Title
# orig_num_clip Original Title + Number + Clip Title
# orig_clip_num Original Title + Clip Title + Number
self.split_video_name_mode = 'orig_num_clip'
# Flag set to True if the video clips should be moved to the 'Video
# Clips' system folder, False if they should be saved in the same
# place as the original video
self.split_video_clips_dir_flag = True
# Flag set to True if the video clips should be moved into a
# sub-directory, with the same name as the original video. The
# subdirectory is either within the 'Video Clips' system folder, or
# within the original video's parent folder, depending on the value
# of self.split_video_clips_dir_flag
self.split_video_subdir_flag = False
# Flag set to True if the video clips should be added to Tartube's
# database, if possible (for example, a media.Folder cannot be
# created within a media.Channel. When self.split_video_subdir_flag
# is True and it's not possible to create a media.Folder, then a new
# sub-directory is created in the filesystem anyway, and the video
# clips are moved there)
self.split_video_add_db_flag = True
# Flag set to True if the each video clip should be given its own
# thumbnail, a copy of the original video's thumbnail
self.split_video_copy_thumb_flag = True
# Clip titles used if the user/video description does not specify one
# Generic title (cannot be changed by the user)
self.split_video_generic_title = 'Video'
# Custom title (can be changed by the user. If an empty string, the
# generic title is used)
self.split_video_custom_title = 'Video'
# Flag set to True if the destination directory should be opened on
# the desktop, after splitting files
self.split_video_auto_open_flag = False
# Flag set to True if the original video should be deleted after
# splitting files. Does not apply to a video in a media.Channel or
# media.Playlist
self.split_video_auto_delete_flag = False
# Temporary timestamp buffer, using the same format as
# media.Video.stamp_List. Used when the user right-clicks a video and
# selects 'Create video clip...' or 'Download video clip...'
self.temp_stamp_list = []
# Flag set to True if downloads.VideoDownloader should contact the
# SponsorBlock server, when checking/downloading videos
self.sblock_fetch_flag = False
# Flag set to True if we should obfuscate the video's ID, when
# contacting the server (recommended for privacy)
self.sblock_obfuscate_flag = True
# Flag set to True if the previous set of video slices should be
# replaced, when a video is checked/downloaded
self.sblock_replace_flag = False
# Flag set to True if, just before trying to remove slices from a
# video, downloads.ClipDownloader and process.ProcessManager should
# contact SponsorBlock again to update the video slice list (if it is
# currently empty)
self.sblock_re_extract_flag = False
# Flag set to True if timestamps/slices should be removed from a video,
# after it is sliced (since they are then incorrect)
self.slice_video_cleanup_flag = True
# Temporary marked slice buffer, using the same format as
# media.Video.slice_List. Used when the user right-clicks a video
# and selects 'Remove video slices...'
self.temp_slice_list = []
# Flag set to True if download operations with yt-dlp should add the
# '--write-comments' option, downloading comments to the .info.json
# file
# Flag used in simulated downloads (checking videos)
self.check_comment_fetch_flag = False
# Flag used in real downloads
self.dl_comment_fetch_flag = False
# Flag set to True if the comments should also be stored in the Tartube
# database, in each media.Vidoe object
self.comment_store_flag = False
# Flag set to False if the 'timestamp' field should be visible in the
# config.VideoEditWin; True if the 'time' field should be visible
# (as of v2.3.318, all comments in a YouTube video share the same
# timestamp)
self.comment_show_text_time_flag = True
# Flag set to False if a flat list of comments should be visible in the
# config.VideoEditWin; True if a formatted list should be visible
self.comment_show_formatted_flag = True
# Flag set to True if 'Child process exited with non-zero code'
# messages, generated by Tartube, should be ignored (in the
# Errors/Warnings tab)
self.ignore_child_process_exit_flag = True
# Flag set to True if 'unable to download video data: HTTP Error 404'
# and 'Unable to extract video data' messages from youtube-dl should
# be ignored (in the Errors/Warnings tab)
self.ignore_http_404_error_flag = False
# Flag set to True if 'Did not get any data blocks' messages from
# youtube-dl should be ignored (in the Errors/Warnings tab)
self.ignore_data_block_error_flag = False
# Flag set to True if 'Requested formats are incompatible for merge and
# will be merged into mkv' messages from youtube-dl should be ignored
# (in the Errors/Warnings tab)
self.ignore_merge_warning_flag = False
# Flag set to True if 'No video formats found; please report this
# issue on...' messages from youtube-dl should be ignored (in the
# Errors/Warnings tab)
self.ignore_missing_format_error_flag = False
# Flag set to True if 'There are no annotations to write' messages
# should be ignored (in the Errors/Warnings tab)
self.ignore_no_annotations_flag = True
# Flag set to True if 'video doesn't have subtitles' errors should be
# ignored (in the Errors/Warnings tab)
self.ignore_no_subtitles_flag = True
# Flag set to True if 'A channel/user page was given' warnings should
# be ignored (in the Errors/Warnings tab)
self.ignore_page_given_flag = False
# Flag set to True if 'There's no playlist description to write'
# warnings should be ignored (in the Errors/Warnings tab)
self.ignore_no_descrip_flag = False
# Flag set to True if 'Unable to download video thumbnail [N]: HTTP
# Error 404: Not Found' warnings should be ignored (in the Errors/
# Warnings tab)
self.ignore_thumb_404_flag = True
# Flag set to True if YouTube copyright messages should be ignored (in
# the Errors/Warnings tab)
self.ignore_yt_copyright_flag = False
# Flag set to True if YouTube age-restriction messages should be
# ignored (in the Errors/Warnings tab)
self.ignore_yt_age_restrict_flag = False
# Flag set to True if 'The uploader has not made this video available'
# messages should be ignored (in the Errors/Warnings tab)
self.ignore_yt_uploader_deleted_flag = False
# Flag set to True if 'This video requires payment to watch' errors
# should be ignored (in the Errors/Warnings tab)
self.ignore_yt_payment_flag = False
# Websites other than YouTube typically use different error messages
# A custom list of strings or regexes, which are matched against error
# messages. Any matching error messages are not displayed in the
# Errors/Warnings tab. The user can add
self.ignore_custom_msg_list = []
# Flag set to True if the contents of the list are regexes, False if
# they are ordinary strings
self.ignore_custom_regex_flag = False
# During a download operation, the number of simultaneous downloads
# allowed. (An instruction to youtube-dl to download video(s) from a
# single URL is called a download job)
# NB Because Tartube just passes a set of instructions to youtube-dl
# and then waits for the results, an increase in this number is
# applied to a download operation immediately, but a decrease is not
# applied until one of the download jobs has finished
self.num_worker_default = 2
# (Absolute minimum and maximum values)
self.num_worker_max = 32
self.num_worker_min = 1
# Flag set to True when the limit is actually applied, False when not
self.num_worker_apply_flag = True
# Flag set to True if the maximum simultaneous downloads limit should
# be bypassed, if a broadcasting livestream is to be downloaded
# (For example, the maximum is two, but three livestreams are
# broadcasting; in that case, we allow the creation of an extra
# downloads.DownloadWorker to handle it. That worker is only used
# for broadcasting livestreams, and otherwise stands idle)
self.num_worker_bypass_flag = True
# During a download operation, the bandwith limit (in KiB/s)
# NB Because Tartube just passes a set of instructions to youtube-dl,
# any change in this value is not applied until one of the download
# jobs has finished
self.bandwidth_default = 500
# (Absolute minimum and maximum values)
self.bandwidth_max = 10000
self.bandwidth_min = 1
# Flag set to True when the limit is currently applied, False when not
self.bandwidth_apply_flag = False
# During a download operation, the maximum video resolution to
# download. Must be one of the keys in formats.VIDEO_RESOLUTION_DICT
# (e.g. '720p')
self.video_res_default = '720p'
# Flag set to True when this maximum video resolution is applied. When
# applied, it overrides the download option 'video_format_list' (see
# the comments in options.OptionsManager)
self.video_res_apply_flag = False
# Alternative performance limits (applied at certain times of the
# day/week)
# Note that these limits, if applied, apply to the whole video/
# channel/playlist, at the moment the video/channel/playlist download
# starts. Tartube cannot magically change youtube-dl's internal
# settings once the download has started
self.alt_num_worker = 4
self.alt_num_worker_apply_flag = False
self.alt_bandwidth = 1000
self.alt_bandwidth_apply_flag = False
# Two 24 hour clock times, marking the start and stop of the period
# during which alternative limits are applied. If the stop time is
# earlier than the start time, then it is applied the next day
self.alt_start_time = '21:00'
self.alt_stop_time = '07:00'
# A string describing the days on which the limit is applied:
# 'every_day', 'weekdays', 'weekends', or 'monday', 'tuesday' etc.
# The strings are translated by formats.SPECIFIED_DAYS_DICT
self.alt_day_string = 'every_day'
# The method of matching downloaded videos against existing
# media.Video objects:
# 'exact_match' - The video name must match exactly
# 'match_first' - The first n characters of the video name must
# match exactly
# 'ignore_last' - All characters before the last n characters of
# the video name must match exactly
self.match_method = 'exact_match'
# Default values for self.match_first_chars and .match_ignore_chars
self.match_default_chars = 10
# For 'match_first', the number of characters (n) to use. Set to the
# default value when self.match_method is not 'match_first'; range
# 1-999
self.match_first_chars = self.match_default_chars
# For 'ignore_last', the number of characters (n) to ignore. Set to the
# default value of when self.match_method is not 'ignore_last'; range
# 1-999
self.match_ignore_chars = self.match_default_chars
# Automatic video deletion/removal. Applies only to downloaded videos
# (not to checked videos)
# Flag set to True if videos (and all their associated files) should be
# deleted after a certain time
# (Note that if both self.auto_delete_flag and self.auto_remove_flag
# are True, and using the same time, then deletion not removal
# occurs)
self.auto_delete_flag = False
# Videos are automatically deleted after this many days (must be an
# integer, minimum value 0; ignored if self.auto_delete_flag is
# False)
self.auto_delete_days = 30
# Flag set to True if videos should be removed from the Tartube
# database after a certain time, but with no files deleted
self.auto_remove_flag = False
# Videos are automatically removed after this many days (must be an
# integer, minimum value 0; ignored if self.auto_remove_flag is
# False)
self.auto_remove_days = 30
# Flag set to True if videos should be automatically deleted/removed,
# but only if they have been watched (media.Video.dl_flag is True,
# media.Video.new_flag is False; ignored if
# self.auto_delete_flag and/or self.auto_remove_flag are False)
self.auto_delete_watched_flag = False
# Flag set to True if the deletion/removal should take place after
# every download operation. If False, it takes place when the
# database is loaded
self.auto_delete_asap_flag = False
# Temporary folder emptying (applies to all media.Folder objects whose
# .temp_flag is True)
# Temporary folders are always emptied when Tartube starts. Flag set to
# True if they should be emptied when Tartube shuts down, as well
self.delete_on_shutdown_flag = False
# Flag set to True if temporary folders should be opened (on the
# desktop) when Tartube shuts down, so the user can more conveniently
# copy things out of it (but only if videos actually exist in the
# folder(s). Ignored if self.delete_on_shutdown_flag is True
self.open_temp_on_desktop_flag = False
# How much information to show in the Video Index. False to show
# minimal video stats, True to show full video stats
self.complex_index_flag = False
# The Video Catalogue has two 'skins', a simple view (without
# thumbnails) and a more complex view (with thumbnails)
# Each skin can be set to show the name of the parent channel/playlist/
# folder, or not
# The current Video Catalogue mode:
# 'simple_hide_parent' - No thumbnail, show description
# 'simple_show_parent' - No thumbnail, show parent
# 'complex_hide_parent' - Thumbnail, show description
# 'complex_hide_parent_ext' - Thumbnail, description & extra labels
# 'complex_show_parent' - Thumbnail, show parent
# 'complex_show_parent_ext' - Thumbnail, parent & extra labels
# 'grid_show_parent' - Grid mode with thumbnail and parent
# 'grid_show_parent_ext' - Grid mode with thumb, parent & extra
# labels
self.catalogue_mode = 'grid_show_parent'
# The current Video Catalogue mode type: 'simple', 'complex' or 'grid'
self.catalogue_mode_type = 'grid'
# Ordered list of Video Catalogue modes, used for switching between
# them
self.catalogue_mode_list = [
[ 'simple_hide_parent', 'simple' ],
[ 'simple_show_parent', 'simple' ],
[ 'complex_hide_parent', 'complex' ],
[ 'complex_hide_parent_ext', 'complex' ],
[ 'complex_show_parent', 'complex' ],
[ 'complex_show_parent_ext', 'complex' ],
[ 'grid_show_parent', 'grid' ],
[ 'grid_show_parent_ext', 'grid' ],
]
# The Video Catalogue splits its video list into pages (as Gtk
# struggles with a list of hundreds, or thousands, of videos)
# The number of videos per page, or 0 to always use a single page
self.catalogue_page_size = 50
# Flag set to True if the Video Catalogue toolbar should show an
# extra row, containing video filter options
self.catalogue_show_filter_flag = False
# Video catalogue sorting mode: 'default' to sort by upload time,
# 'alpha' to sort alphabetically, 'receive' to sort by download
# time, 'dbid' to sort by the video's database ID (.dbid)
# When set to 'default', the sorting algorithm actually sorts by
# livestream status, then by playlist index, then by upload time,
# then by receive time, then by name, then by .dbid
# The other values are more strict, sorting only by specified method,
# then (only if necessary) by name or by .dbid
# Note that YouTube and others only provide an upload date, which
# Tartube converts to a time (and is not, therefore, accurate)
self.catalogue_sort_mode = 'default'
# Flag set to True if the 'Regex' button is toggled on, meaning that
# when the searching the catalogue, we match videos using a regex,
# rather than a simple string
self.catologue_use_regex_flag = False
# Two flags used for bulk-editing URLS of media data objects (in the
# config.SystemPrefWin window)
# Flag set to True if the user should be prompted for confirmation
# every time an individual URL is changed (in the window)
self.url_change_confirm_flag = True
# Flag set to True if search/replace operations on multiple URLs
# should use a regex, False if the pattern is an ordinary substring
self.url_change_regex_flag = True
# Default and customisable colours used as backgrounds in the Video
# Catalogue to highlight livestream/debut videos. (The Video
# Catalogue uses three different formats, and not every format uses
# every colour)
# Colours are stored as lists in the form [R, G, B, A], matching the
# arguments for a Gdk.RGBA object
# Dictionary of default background colours
self.default_bg_table = {
# Not selected
'live_wait': [1, 0, 0, 0.1], # Red
'live_now': [0, 1, 0, 0.2], # Green
'debut_wait': [1, 1, 0, 0.2], # Yellow
'debut_now': [0, 1, 1, 0.2], # Cyan
# Selected
'select': [0, 0, 1, 0.1], # Blue
'select_wait': [1, 0, 1, 0.1], # Purple
'select_live': [1, 0, 1, 0.1], # Purple
# Drag and drop tab
'drag_drop_notify': [1, 0, 1, 0.1], # Purple
'drag_drop_odd': [1, 1, 0, 0.1], # Orange
'drag_drop_even': [1, 1, 0, 0.05], # Pale orange
}
# Dictionary of customisable colours
self.custom_bg_table = self.default_bg_table.copy()
# Dictionary of youtube-dl download options that are filtered out, when
# splitting video clips (in a call to
# utils.generate_split_system_cmd())
# The keys are youtube-dl download options; the corresponding values
# are False for a boolean option, or True for an option that takes
# an argument
self.split_ignore_option_dict = {
# DOWNLOAD OPTIONS
# native_hls
'--hls-prefer-native': False,
# external_downloader
'--external-downloader': True,
# external_arg_string
'--external-downloader-args': True,
# FILESYSTEM OPTIONS
# (builds --output and --paths)
'-o': True,
'--output': True,
'-p': True,
'--paths': True,
# write_description
'--write-description': False,
# write_info
'--write-info-json': False,
# write_annotations
'--write-annotations': False,
# THUMBNAIL IMAGES
# write_thumbnail
'--write-thumbnail': False,
# VIDEO FORMAT OPTIONS
# all_formats
'--all-formats': False,
# prefer_free_formats
'--prefer-free-formats': False,
# yt_skip_dash
'--youtube-skip-dash-manifest': False,
# SUBTITLE OPTIONS
# write_subs
'--write-sub': False,
# write_auto_subs
'--write-auto-sub': False,
# write_all_subs
'--all-subs': False,
# subs_format
'--sub-format': True,
# subs_lang
'--sub-lang': True,
# POST-PROCESSING OPTIONS
# embed_subs
'--embed-subs': False,
# prefer_avconv
'--prefer-avconv': False,
# prefer_ffmpeg
'--prefer-ffmpeg': False,
# (Added directly in options.OptionsManager)
'--newline': False,
# YT-DLP OPTIONS
'--extractor-args': True,
'--split-chapters': False,
}
# Flag set to True if download options unique to yt-dlp should be
# filtered out, when self.ytdl_fork is not set to 'yt-dlp'
self.ytdlp_filter_options_flag = True
# Dictionary of yt-dlp options to filter out, in that case
# The keys are youtube-dl download options; the corresponding values
# are False for a boolean option, or True for an option that takes
# an argument
self.ytdlp_exclusive_options_dict = {
# not passed to yt-dlp directly
'--paths': True,
'-P': True, # Alias of --paths
'--extractor-args': True,
# Options
'live_from_start': False,
'wait_for_video_min': 0,
# Video Selection Options
'--playlist-items': True,
'-I': True, # Alias of --playlist-items
'--break-on-existing': False,
'--break-on-reject': False,
'--skip-playlist-after-errors': True,
# Download Options
'--concurrent-fragments': True,
'-N': True, # Alias of --concurrent-fragments
'--throttled-rate': True,
# Filesystem Options
'--windows-filenames': False,
'--trim-filenames': True,
'--no-overwrites': False,
'--force-overwrites': False,
'--write-playlist-metafiles': False,
'--no-clean-infojson': False,
'--no-cookies': False,
'--cookies-from-browser': '',
'--no-cookies-from-browser': True,
# Internet Shortcut Options
'--write-link': False,
'--write-url-link': False,
'--write-webloc-link': False,
'--write-desktop-link': False,
# Verbosity and Simulation Options
'--ignore-no-formats-error': False,
'--force-write-archive': False,
# Workaround Options
'--sleep-requests': True,
'--sleep-subtitles': True,
# Video Format Options
'--video-multistreams': False,
'--audio-multistreams': False,
'--check-formats': False,
'--allow-unplayable-formats': False,
# Post-Processing Options
'--remux-video': True,
'--embed-metadata': False,
'--convert-thumbnails': True,
'--split-chapters': False,
# Extractor Options
'--extractor-retries': True,
'--no_allow_dynamic_mpd': False,
'--hls-split-discontinuity': False,
}
def do_startup(self):
"""Gio.Application standard function."""
GObject.threads_init()
Gtk.Application.do_startup(self)
# Menu actions
# ------------
# 'File' column
change_db_menu_action = Gio.SimpleAction.new('change_db_menu', None)
change_db_menu_action.connect('activate', self.on_menu_change_db)
self.add_action(change_db_menu_action)
check_db_menu_action = Gio.SimpleAction.new('check_db_menu', None)
check_db_menu_action.connect('activate', self.on_menu_check_db)
self.add_action(check_db_menu_action)
save_db_menu_action = Gio.SimpleAction.new('save_db_menu', None)
save_db_menu_action.connect('activate', self.on_menu_save_db)
self.add_action(save_db_menu_action)
save_all_menu_action = Gio.SimpleAction.new('save_all_menu', None)
save_all_menu_action.connect('activate', self.on_menu_save_all)
self.add_action(save_all_menu_action)
close_tray_menu_action = Gio.SimpleAction.new('close_tray_menu', None)
close_tray_menu_action.connect('activate', self.on_menu_close_tray)
self.add_action(close_tray_menu_action)
quit_menu_action = Gio.SimpleAction.new('quit_menu', None)
quit_menu_action.connect('activate', self.on_menu_quit)
self.add_action(quit_menu_action)
# 'Edit' column
system_prefs_action = Gio.SimpleAction.new('system_prefs_menu', None)
system_prefs_action.connect(
'activate',
self.on_menu_system_preferences,
)
self.add_action(system_prefs_action)
gen_options_action = Gio.SimpleAction.new('gen_options_menu', None)
gen_options_action.connect('activate', self.on_menu_general_options)
self.add_action(gen_options_action)
# 'System' column
if os.name == 'nt':
open_msys2_action = Gio.SimpleAction.new('open_msys2_menu', None)
open_msys2_action.connect('activate', self.on_menu_open_msys2)
self.add_action(open_msys2_action)
show_install_action = Gio.SimpleAction.new(
'show_install_menu',
None,
)
show_install_action.connect('activate', self.on_menu_show_install)
self.add_action(show_install_action)
show_script_action = Gio.SimpleAction.new(
'show_script_menu',
None,
)
show_script_action.connect('activate', self.on_menu_show_script)
self.add_action(show_script_action)
# 'Media' column
add_video_menu_action = Gio.SimpleAction.new('add_video_menu', None)
add_video_menu_action.connect('activate', self.on_menu_add_video)
self.add_action(add_video_menu_action)
add_channel_menu_action = Gio.SimpleAction.new(
'add_channel_menu',
None,
)
add_channel_menu_action.connect('activate', self.on_menu_add_channel)
self.add_action(add_channel_menu_action)
add_playlist_menu_action = Gio.SimpleAction.new(
'add_playlist_menu',
None,
)
add_playlist_menu_action.connect(
'activate',
self.on_menu_add_playlist,
)
self.add_action(add_playlist_menu_action)
add_folder_menu_action = Gio.SimpleAction.new('add_folder_menu', None)
add_folder_menu_action.connect('activate', self.on_menu_add_folder)
self.add_action(add_folder_menu_action)
add_bulk_menu_action = Gio.SimpleAction.new('add_bulk_menu', None)
add_bulk_menu_action.connect('activate', self.on_menu_add_bulk)
self.add_action(add_bulk_menu_action)
reset_container_menu_action = Gio.SimpleAction.new(
'reset_container_menu',
None,
)
reset_container_menu_action.connect(
'activate',
self.on_menu_reset_container,
)
self.add_action(reset_container_menu_action)
export_db_menu_action = Gio.SimpleAction.new('export_db_menu', None)
export_db_menu_action.connect('activate', self.on_menu_export_db)
self.add_action(export_db_menu_action)
import_db_menu_action = Gio.SimpleAction.new('import_db_menu', None)
import_db_menu_action.connect('activate', self.on_menu_import_db)
self.add_action(import_db_menu_action)
import_yt_menu_action = Gio.SimpleAction.new('import_yt_menu', None)
import_yt_menu_action.connect('activate', self.on_menu_import_yt)
self.add_action(import_yt_menu_action)
switch_view_menu_action = Gio.SimpleAction.new(
'switch_view_menu',
None,
)
switch_view_menu_action.connect('activate', self.on_button_switch_view)
self.add_action(switch_view_menu_action)
hide_system_menu_action = Gio.SimpleAction.new(
'hide_system_menu',
None,
)
hide_system_menu_action.connect('activate', self.on_menu_hide_system)
self.add_action(hide_system_menu_action)
show_hidden_menu_action = Gio.SimpleAction.new(
'show_hidden_menu',
None,
)
show_hidden_menu_action.connect('activate', self.on_menu_show_hidden)
self.add_action(show_hidden_menu_action)
auto_switch_menu_action = Gio.SimpleAction.new(
'auto_switch_menu',
None,
)
auto_switch_menu_action.connect(
'activate',
self.on_menu_auto_switch,
)
self.add_action(auto_switch_menu_action)
create_profile_menu_action = Gio.SimpleAction.new(
'create_profile_menu',
None,
)
create_profile_menu_action.connect(
'activate',
self.on_menu_create_profile,
)
self.add_action(create_profile_menu_action)
mark_all_menu_action = Gio.SimpleAction.new(
'mark_all_menu',
None,
)
mark_all_menu_action.connect('activate', self.on_menu_mark_all)
self.add_action(mark_all_menu_action)
unmark_all_menu_action = Gio.SimpleAction.new(
'unmark_all_menu',
None,
)
unmark_all_menu_action.connect('activate', self.on_menu_unmark_all)
self.add_action(unmark_all_menu_action)
if self.debug_test_media_menu_flag:
test_menu_action = Gio.SimpleAction.new('test_menu', None)
test_menu_action.connect('activate', self.on_menu_test)
self.add_action(test_menu_action)
if self.debug_test_code_menu_flag:
test_code_menu_action = Gio.SimpleAction.new(
'test_code_menu',
None,
)
test_code_menu_action.connect('activate', self.on_menu_test_code)
self.add_action(test_code_menu_action)
# 'Operations' column
check_all_menu_action = Gio.SimpleAction.new('check_all_menu', None)
check_all_menu_action.connect(
'activate',
self.on_menu_check_all,
)
self.add_action(check_all_menu_action)
download_all_menu_action = Gio.SimpleAction.new(
'download_all_menu',
None,
)
download_all_menu_action.connect(
'activate',
self.on_menu_download_all,
)
self.add_action(download_all_menu_action)
refresh_db_menu_action = Gio.SimpleAction.new('refresh_db_menu', None)
refresh_db_menu_action.connect('activate', self.on_menu_refresh_db)
self.add_action(refresh_db_menu_action)
ytdl_menu_action = Gio.SimpleAction.new('update_ytdl_menu', None)
ytdl_menu_action.connect('activate', self.on_menu_update_ytdl)
self.add_action(ytdl_menu_action)
ytdl_test_menu_action = Gio.SimpleAction.new('test_ytdl_menu', None)
ytdl_test_menu_action.connect('activate', self.on_menu_test_ytdl)
self.add_action(ytdl_test_menu_action)
if os.name == 'nt':
ffmpeg_menu_action = Gio.SimpleAction.new(
'install_ffmpeg_menu',
None,
)
ffmpeg_menu_action.connect(
'activate',
self.on_menu_install_ffmpeg,
)
self.add_action(ffmpeg_menu_action)
matplotlib_menu_action = Gio.SimpleAction.new(
'install_matplotlib_menu',
None,
)
matplotlib_menu_action.connect(
'activate',
self.on_menu_install_matplotlib,
)
self.add_action(matplotlib_menu_action)
streamlink_menu_action = Gio.SimpleAction.new(
'install_streamlink_menu',
None,
)
streamlink_menu_action.connect(
'activate',
self.on_menu_install_streamlink,
)
self.add_action(streamlink_menu_action)
tidy_up_menu_action = Gio.SimpleAction.new('tidy_up_menu', None)
tidy_up_menu_action.connect('activate', self.on_menu_tidy_up)
self.add_action(tidy_up_menu_action)
stop_operation_menu_action = Gio.SimpleAction.new(
'stop_operation_menu',
None,
)
stop_operation_menu_action.connect(
'activate',
self.on_button_stop_operation,
)
self.add_action(stop_operation_menu_action)
stop_soon_menu_action = Gio.SimpleAction.new('stop_soon_menu', None)
stop_soon_menu_action.connect('activate', self.on_menu_stop_soon)
self.add_action(stop_soon_menu_action)
# 'Livestreams' column
live_prefs_menu_action = Gio.SimpleAction.new(
'live_prefs_menu',
None,
)
live_prefs_menu_action.connect(
'activate',
self.on_menu_live_preferences,
)
self.add_action(live_prefs_menu_action)
update_live_menu_action = Gio.SimpleAction.new(
'update_live_menu',
None,
)
update_live_menu_action.connect('activate', self.on_menu_update_live)
self.add_action(update_live_menu_action)
cancel_live_menu_action = Gio.SimpleAction.new(
'cancel_live_menu',
None,
)
cancel_live_menu_action.connect('activate', self.on_menu_cancel_live)
self.add_action(cancel_live_menu_action)
# 'Help' column
about_menu_action = Gio.SimpleAction.new('about_menu', None)
about_menu_action.connect('activate', self.on_menu_about)
self.add_action(about_menu_action)
check_version_menu_action = Gio.SimpleAction.new(
'check_version_menu',
None,
)
check_version_menu_action.connect(
'activate',
self.on_menu_check_version,
)
self.add_action(check_version_menu_action)
go_website_menu_action = Gio.SimpleAction.new('go_website_menu', None)
go_website_menu_action.connect('activate', self.on_menu_go_website)
self.add_action(go_website_menu_action)
send_feedback_menu_action = Gio.SimpleAction.new(
'send_feedback_menu',
None,
)
send_feedback_menu_action.connect(
'activate',
self.on_menu_send_feedback,
)
self.add_action(send_feedback_menu_action)
# Main toolbar actions
# --------------------
add_video_toolbutton_action = Gio.SimpleAction.new(
'add_video_toolbutton',
None,
)
add_video_toolbutton_action.connect(
'activate',
self.on_menu_add_video,
)
self.add_action(add_video_toolbutton_action)
add_channel_toolbutton_action = Gio.SimpleAction.new(
'add_channel_toolbutton',
None,
)
add_channel_toolbutton_action.connect(
'activate',
self.on_menu_add_channel,
)
self.add_action(add_channel_toolbutton_action)
add_playlist_toolbutton_action = Gio.SimpleAction.new(
'add_playlist_toolbutton',
None,
)
add_playlist_toolbutton_action.connect(
'activate',
self.on_menu_add_playlist,
)
self.add_action(add_playlist_toolbutton_action)
add_folder_toolbutton_action = Gio.SimpleAction.new(
'add_folder_toolbutton',
None,
)
add_folder_toolbutton_action.connect(
'activate',
self.on_menu_add_folder,
)
self.add_action(add_folder_toolbutton_action)
check_all_toolbutton_action = Gio.SimpleAction.new(
'check_all_toolbutton',
None,
)
check_all_toolbutton_action.connect(
'activate',
self.on_menu_check_all,
)
self.add_action(check_all_toolbutton_action)
download_all_toolbutton_action = Gio.SimpleAction.new(
'download_all_toolbutton',
None,
)
download_all_toolbutton_action.connect(
'activate',
self.on_menu_download_all,
)
self.add_action(download_all_toolbutton_action)
stop_operation_button_action = Gio.SimpleAction.new(
'stop_operation_toolbutton',
None,
)
stop_operation_button_action.connect(
'activate',
self.on_button_stop_operation,
)
self.add_action(stop_operation_button_action)
switch_view_button_action = Gio.SimpleAction.new(
'switch_view_toolbutton',
None,
)
switch_view_button_action.connect(
'activate',
self.on_button_switch_view,
)
self.add_action(switch_view_button_action)
hide_system_button_action = Gio.SimpleAction.new(
'hide_system_toolbutton',
None,
)
hide_system_button_action.connect(
'activate',
self.on_button_hide_system,
)
self.add_action(hide_system_button_action)
quit_button_action = Gio.SimpleAction.new('quit_toolbutton', None)
quit_button_action.connect('activate', self.on_menu_quit)
self.add_action(quit_button_action)
# Video catalogue toolbar actions
# -------------------------------
first_page_toolbutton_action = Gio.SimpleAction.new(
'first_page_toolbutton',
None,
)
first_page_toolbutton_action.connect(
'activate',
self.on_button_first_page,
)
self.add_action(first_page_toolbutton_action)
previous_page_toolbutton_action = Gio.SimpleAction.new(
'previous_page_toolbutton',
None,
)
previous_page_toolbutton_action.connect(
'activate',
self.on_button_previous_page,
)
self.add_action(previous_page_toolbutton_action)
next_page_toolbutton_action = Gio.SimpleAction.new(
'next_page_toolbutton',
None,
)
next_page_toolbutton_action.connect(
'activate',
self.on_button_next_page,
)
self.add_action(next_page_toolbutton_action)
last_page_toolbutton_action = Gio.SimpleAction.new(
'last_page_toolbutton',
None,
)
last_page_toolbutton_action.connect(
'activate',
self.on_button_last_page,
)
self.add_action(last_page_toolbutton_action)
scroll_up_toolbutton_action = Gio.SimpleAction.new(
'scroll_up_toolbutton',
None,
)
scroll_up_toolbutton_action.connect(
'activate',
self.on_button_scroll_up,
)
self.add_action(scroll_up_toolbutton_action)
scroll_down_toolbutton_action = Gio.SimpleAction.new(
'scroll_down_toolbutton',
None,
)
scroll_down_toolbutton_action.connect(
'activate',
self.on_button_scroll_down,
)
self.add_action(scroll_down_toolbutton_action)
show_filter_toolbutton_action = Gio.SimpleAction.new(
'show_filter_toolbutton',
None,
)
show_filter_toolbutton_action.connect(
'activate',
self.on_button_show_filter,
)
self.add_action(show_filter_toolbutton_action)
# (Second/third rows)
resort_toolbutton_action = Gio.SimpleAction.new(
'resort_toolbutton',
None,
)
resort_toolbutton_action.connect(
'activate',
self.on_button_resort_catalogue,
)
self.add_action(resort_toolbutton_action)
use_regex_togglebutton_action = Gio.SimpleAction.new(
'use_regex_togglebutton',
None,
)
use_regex_togglebutton_action.connect(
'activate',
self.on_button_use_regex,
)
self.add_action(use_regex_togglebutton_action)
apply_filter_button_action = Gio.SimpleAction.new(
'apply_filter_toolbutton',
None,
)
apply_filter_button_action.connect(
'activate',
self.on_button_apply_filter,
)
self.add_action(apply_filter_button_action)
cancel_filter_button_action = Gio.SimpleAction.new(
'cancel_filter_toolbutton',
None,
)
cancel_filter_button_action.connect(
'activate',
self.on_button_cancel_filter,
)
self.add_action(cancel_filter_button_action)
find_date_toolbutton_action = Gio.SimpleAction.new(
'find_date_toolbutton',
None,
)
find_date_toolbutton_action.connect(
'activate',
self.on_button_find_date,
)
self.add_action(find_date_toolbutton_action)
cancel_date_toolbutton_action = Gio.SimpleAction.new(
'cancel_date_toolbutton',
None,
)
cancel_date_toolbutton_action.connect(
'activate',
self.on_button_cancel_date,
)
self.add_action(cancel_date_toolbutton_action)
# Videos tab actions
# ------------------
# Buttons
check_all_button_action = Gio.SimpleAction.new(
'check_all_button',
None,
)
check_all_button_action.connect('activate', self.on_button_check_all)
self.add_action(check_all_button_action)
download_all_button_action = Gio.SimpleAction.new(
'download_all_button',
None,
)
download_all_button_action.connect(
'activate',
self.on_button_download_all,
)
self.add_action(download_all_button_action)
custom_dl_all_button_action = Gio.SimpleAction.new(
'custom_dl_all_button',
None,
)
custom_dl_all_button_action.connect(
'activate',
self.on_button_custom_dl_all,
)
self.add_action(custom_dl_all_button_action)
custom_dl_select_button_action = Gio.SimpleAction.new(
'custom_dl_select_button',
None,
)
custom_dl_select_button_action.connect(
'activate',
self.on_menu_custom_dl_select,
)
self.add_action(custom_dl_select_button_action)
# Classic Mode tab actions
# ------------------------
# Buttons
classic_menu_button_action = Gio.SimpleAction.new(
'classic_menu_button',
None,
)
classic_menu_button_action.connect(
'activate',
self.on_button_classic_menu,
)
self.add_action(classic_menu_button_action)
classic_dest_dir_button_action = Gio.SimpleAction.new(
'classic_dest_dir_button',
None,
)
classic_dest_dir_button_action.connect(
'activate',
self.on_button_classic_dest_dir,
)
self.add_action(classic_dest_dir_button_action)
classic_dest_dir_open_action = Gio.SimpleAction.new(
'classic_dest_dir_open_button',
None,
)
classic_dest_dir_open_action.connect(
'activate',
self.on_button_classic_dest_dir_open,
)
self.add_action(classic_dest_dir_open_action)
classic_add_urls_button_action = Gio.SimpleAction.new(
'classic_add_urls_button',
None,
)
classic_add_urls_button_action.connect(
'activate',
self.on_button_classic_add_urls,
)
self.add_action(classic_add_urls_button_action)
classic_play_button_action = Gio.SimpleAction.new(
'classic_play_button',
None,
)
classic_play_button_action.connect(
'activate',
self.on_button_classic_play,
)
self.add_action(classic_play_button_action)
classic_open_button_action = Gio.SimpleAction.new(
'classic_open_button',
None,
)
classic_open_button_action.connect(
'activate',
self.on_button_classic_open,
)
self.add_action(classic_open_button_action)
classic_redownload_button_action = Gio.SimpleAction.new(
'classic_redownload_button',
None,
)
classic_redownload_button_action.connect(
'activate',
self.on_button_classic_redownload,
)
self.add_action(classic_redownload_button_action)
classic_stop_button_action = Gio.SimpleAction.new(
'classic_stop_button',
None,
)
classic_stop_button_action.connect(
'activate',
self.on_button_classic_stop,
)
self.add_action(classic_stop_button_action)
classic_archive_button_action = Gio.SimpleAction.new(
'classic_archive_button',
None,
)
classic_archive_button_action.connect(
'activate',
self.on_button_classic_archive,
)
self.add_action(classic_archive_button_action)
classic_ffmpeg_button_action = Gio.SimpleAction.new(
'classic_ffmpeg_button',
None,
)
classic_ffmpeg_button_action.connect(
'activate',
self.on_button_classic_ffmpeg,
)
self.add_action(classic_ffmpeg_button_action)
classic_move_up_button_action = Gio.SimpleAction.new(
'classic_move_up_button',
None,
)
classic_move_up_button_action.connect(
'activate',
self.on_button_classic_move_up,
)
self.add_action(classic_move_up_button_action)
classic_move_down_button_action = Gio.SimpleAction.new(
'classic_move_down_button',
None,
)
classic_move_down_button_action.connect(
'activate',
self.on_button_classic_move_down,
)
self.add_action(classic_move_down_button_action)
classic_remove_button_action = Gio.SimpleAction.new(
'classic_remove_button',
None,
)
classic_remove_button_action.connect(
'activate',
self.on_button_classic_remove,
)
self.add_action(classic_remove_button_action)
classic_clear_dl_button_action = Gio.SimpleAction.new(
'classic_clear_dl_button',
None,
)
classic_clear_dl_button_action.connect(
'activate',
self.on_button_classic_clear_dl,
)
self.add_action(classic_clear_dl_button_action)
classic_clear_button_action = Gio.SimpleAction.new(
'classic_clear_button',
None,
)
classic_clear_button_action.connect(
'activate',
self.on_button_classic_clear,
)
self.add_action(classic_clear_button_action)
classic_download_button_action = Gio.SimpleAction.new(
'classic_download_button',
None,
)
classic_download_button_action.connect(
'activate',
self.on_button_classic_download,
)
self.add_action(classic_download_button_action)
# Drag and Drop tab actions
# -------------------------
# Buttons
drag_drop_add_button_action = Gio.SimpleAction.new(
'drag_drop_add_button',
None,
)
drag_drop_add_button_action.connect(
'activate',
self.on_button_drag_drop_add,
)
self.add_action(drag_drop_add_button_action)
# Errors/Warnings tab actions
# ----------------------------
# Buttons
apply_error_filter_button_action = Gio.SimpleAction.new(
'apply_error_filter_toolbutton',
None,
)
apply_error_filter_button_action.connect(
'activate',
self.on_button_apply_error_filter,
)
self.add_action(apply_error_filter_button_action)
cancel_error_filter_button_action = Gio.SimpleAction.new(
'cancel_error_filter_toolbutton',
None,
)
cancel_error_filter_button_action.connect(
'activate',
self.on_button_cancel_error_filter,
)
self.add_action(cancel_error_filter_button_action)
def do_activate(self):
"""Gio.Application standard function."""
# If the flag is set, restrict Tartube to a single instance
if not __main__.__multiple_instance_flag__ and self.main_win_obj:
self.main_win_obj.present()
# Otherwise permit multiple instances
else:
self.start()
# If debugging flags are set...
if self.main_win_obj:
# ...open the system preferences window
if self.debug_open_pref_win_flag:
config.SystemPrefWin(self)
# ...open the general download options window
if self.debug_open_options_win_flag:
config.OptionsEditWin(self, self.general_options_obj)
# ...write the Gtk version to the terminal
if self.debug_write_gtk_flag:
print(
'Tartube running on Gtk v' \
+ str(self.gtk_version_major) + '.' \
+ str(self.gtk_version_minor) + '.' \
+ str(self.gtk_version_micro)
)
def do_shutdown(self):
"""Gio.Application standard function.
Clean shutdowns (for example, from the main window's toolbar) are
handled by self.stop().
N.B. When called by mainwin.MainWin.on_delete_event(), the config/
database files have already been saved.
"""
# Stop the GObject timers immediately
if self.script_slow_timer_id:
GObject.source_remove(self.script_slow_timer_id)
if self.script_fast_timer_id:
GObject.source_remove(self.script_fast_timer_id)
if self.dl_timer_id:
GObject.source_remove(self.dl_timer_id)
if self.update_timer_id:
GObject.source_remove(self.update_timer_id)
if self.refresh_timer_id:
GObject.source_remove(self.refresh_timer_id)
if self.info_timer_id:
GObject.source_remove(self.info_timer_id)
if self.tidy_timer_id:
GObject.source_remove(self.tidy_timer_id)
if self.process_timer_id:
GObject.source_remove(self.process_timer_id)
# Don't prompt the user before halting an operation, as we would do in
# calls to self.stop()
if self.download_manager_obj:
self.download_manager_obj.stop_download_operation()
elif self.update_manager_obj:
self.update_manager_obj.stop_update_operation()
elif self.refresh_manager_obj:
self.refresh_manager_obj.stop_refresh_operation()
elif self.info_manager_obj:
self.info_manager_obj.stop_info_operation()
elif self.tidy_manager_obj:
self.tidy_manager_obj.stop_tidy_operation()
elif self.process_manager_obj:
self.process_manager_obj.stop_process_operation()
# If there is a lock on the database file, release it
self.remove_db_lock_file()
# Stop immediately
Gtk.Application.do_shutdown(self)
# After an update operation, only this method might work
os._exit(0)
# Still here? Do a brute-force exit
exit()
# Public class methods
def start(self):
"""Called by self.do_activate().
Performs general initialisation.
"""
# Part 1 - Give mainapp.TartubeApp IVs their initial values
# ---------------------------------------------------------
# Set youtube-dl path IVs
self.setup_paths()
# Compile a list of available sound effects
self.find_sound_effects()
# Part 2 - create the main window
# -------------------------------
# (The window is not set up, nor made visible, until the config file
# has been loaded/saved/created)
self.main_win_obj = mainwin.MainWin(self)
# Part 3 - setup some managers
# ----------------------------
# Start the dialogue manager (thread-safe code for Gtk message dialogue
# windows)
self.dialogue_manager_obj = dialogue.DialogueManager(
self,
self.main_win_obj,
)
# Set the General Options Manager
self.general_options_obj = self.create_download_options('general')
self.general_options_obj.set_general_options()
# Apply a different set of download options to the Classic Mode tab, by
# default
self.classic_options_obj = self.create_download_options('classic')
self.classic_options_obj.set_classic_mode_options()
# Create a third set of download options for use in the Drag and Drop
# tab
mp3_options_obj = self.create_download_options('mp3')
mp3_options_obj.set_mp3_options()
# Add these options to the Drag and Drop Grid
self.classic_dropzone_list = [
self.general_options_obj.uid,
self.classic_options_obj.uid,
mp3_options_obj.uid,
]
# Set the current FFmpeg Options Manager
self.ffmpeg_options_obj = self.create_ffmpeg_options('default')
# Set the General Custom Download Manager
self.general_custom_dl_obj = self.create_custom_dl_manager('general')
# Use a different manager in the Classic Mode tab, by default
self.classic_custom_dl_obj = self.create_custom_dl_manager('classic')
self.classic_custom_dl_obj.set_dl_precede_flag(True)
# Part 4 - Load the config file
# -----------------------------
# Make sure the directory containing the config file exists
# v2.0.003 (amended v2.1.034) The user can force Tartube to use the
# config file in the script's directory (rather than the one in the
# location described by xdg) by placing a 'settings.json' file there.
# If that file is created when Tartube is already running, it can be
# an empty file (because Tartube overwrites it). Otherwise, it should
# be a copy of a legitimate config file
if not os.path.isfile(self.config_file_path):
config_dir = None
if (
self.config_file_xdg_dir is not None
and not os.path.isdir(self.config_file_xdg_dir)
):
config_dir = self.config_file_xdg_dir
elif (
self.config_file_xdg_dir is None
and not os.path.isdir(self.config_file_dir)
):
config_dir = self.config_file_dir
if config_dir is not None \
and not self.make_directory(config_dir):
dialogue_win \
= self.dialogue_manager_obj.show_simple_msg_dialogue(
_(
'Tartube can\'t create the folder in which its' \
+ ' configuration file is saved',
),
'error',
'ok',
)
dialogue_win.connect('destroy', self.stop)
return
# If the config file exists, load it. If not, create it
new_config_flag = False
if (
self.config_file_xdg_path is not None \
and os.path.isfile(self.config_file_xdg_path)
) or os.path.isfile(self.config_file_path):
new_config_flag = self.load_config()
else:
# The system locale is applied in the call to self.load_config().
# Since we aren't calling that now, we must apply the locale
# directly
if self.custom_locale != formats.LOCALE_DEFAULT:
self.apply_locale()
# Now respond to the missing config file
if self.debug_no_dialogue_flag:
self.save_config()
new_config_flag = True
elif not self.disable_load_save_flag:
# New Tartube installation
new_config_flag = True
if new_config_flag and not self.debug_no_dialogue_flag:
# Open the wizard window, so the user can set the data directory,
# specify which fork of youtube-dl to use, and (depending on the
# system) download and install youtube-dl and/or FFmpeg
self.open_wiz_win()
elif self.disable_load_save_flag:
# Load/save has been disabled. Show the error message in a dialogue
# window, then shut down
msg = _('Tartube failed to start because:') \
+ '\n\n' \
+ utils.tidy_up_long_string(
self.disable_load_save_msg,
self.main_win_obj.long_string_max_len,
) + '\n\n' \
+ utils.tidy_up_long_string(
_(
'If you don\'t know how to resolve this error, please' \
+ ' contact the authors',
),
self.main_win_obj.long_string_max_len,
)
dialogue_win = self.dialogue_manager_obj.show_simple_msg_dialogue(
msg,
'error',
'ok',
)
dialogue_win.connect('destroy', self.stop)
else:
# The config file has been loaded (or created), so continue with
# general initialisation immediately
self.start_continue(new_config_flag)
def start_continue(self, new_config_flag):
"""Called by self.start() or .open_wiz_win_continue().
The config file has been loaded (or created), so continue with general
initialisation immediately.
Args:
new_config_flag (bool): True for a new Tartube installation, False
otherwise
"""
# Part 5 - Finish setting up the main window
# ------------------------------------------
# Resize the main window to match the previous size, if required (but
# don't bother if the previous size is the same as the standard one)
if self.main_win_save_size_flag \
and (
self.main_win_save_width != self.main_win_width
or self.main_win_save_height != self.main_win_height
):
self.main_win_obj.resize_self(
self.main_win_save_width,
self.main_win_save_height,
)
# Create the main window
self.main_win_obj.setup_win()
# Set up widgets in the Video Catalogue toolbar
self.main_win_obj.update_catalogue_filter_widgets()
self.main_win_obj.update_catalogue_sort_widgets()
self.main_win_obj.update_catalogue_thumb_widgets()
# Add the right number of pages to the Output tab
self.main_win_obj.output_tab_setup_pages()
# If the flag it set, switch to the Classic Mode tab
if not __main__.__pkg_no_download_flag__ \
and self.show_classic_tab_on_startup_flag:
self.main_win_obj.notebook.set_current_page(
self.main_win_obj.notebook_tab_dict['classic'],
)
# Most main widgets are desensitised, until the database file has been
# loaded
self.main_win_obj.sensitise_widgets_if_database(False)
# Disable tooltips, if necessary
if not self.show_tooltips_flag:
self.main_win_obj.disable_tooltips()
# Disable the 'Download all' button and related widgets, if necessary
if self.disable_dl_all_flag:
self.main_win_obj.disable_dl_all_buttons()
# If the debugging flag is set, move the window to the top-left corner
# of the desktop
if self.debug_open_top_left_flag:
self.main_win_obj.move(0, 0)
# Prepare to add an icon to the system tray. It becomes actually
# visible only when settings specify that
# Also, the main window must remain invisible, if settings specify that
# Tartube should open in the system tray
self.status_icon_obj = mainwin.StatusIcon(self)
if self.show_status_icon_flag:
self.status_icon_obj.show_icon()
if self.open_in_tray_flag:
self.main_win_obj.force_invisible()
else:
self.main_win_obj.show_all()
else:
self.main_win_obj.show_all()
# Part 6 - Select a database file
# -------------------------------
if not new_config_flag \
and not self.debug_no_dialogue_flag:
# Multiple instances of Tartube can share the same config file, but
# not the same database file
# If the database file specified by the config file we've just
# loaded is locked (meaning it's in use by another instance), we
# might be able to use an alternative data directory
if self.data_dir_use_list_flag:
self.choose_alt_db()
# Check that the data directory specified by self.data_dir actually
# exists. If not, the most common reason is that the user has
# forgotten to mount an external drive
# If the directory doesn't exist, prompt the user for further
# instructions. However, for a new installation (or at least, for a
# new config file), go ahead and try to create the directory without
# prompting, but only once
first_attempt_flag = new_config_flag
make_dir_fail_flag = False
while not os.path.isdir(self.data_dir):
# Ask the user what to do next. The False argument tells the
# dialogue window that it's a missing directory
if not first_attempt_flag:
dialogue_win = mainwin.MountDriveDialogue(
self.main_win_obj,
make_dir_fail_flag,
)
dialogue_win.run()
# If the data directory now exists, or can be created in
# principle by the code just below (because the user wants to
# use the default location), then available_flag will be True
available_flag = dialogue_win.available_flag
dialogue_win.destroy()
if not available_flag:
# The user opted to shut down Tartube. Destroying the main
# window calls self.do_shutdown()
return self.main_win_obj.destroy()
# On subsequent loops, always show the dialogue window
first_attempt_flag = False
# Try creating the specified directory, if it doesn't exist. If
# this fails, the loop is repeated
make_dir_fail_flag = False
if not os.path.isdir(self.data_dir) \
and not self.make_directory(self.data_dir):
make_dir_fail_flag = True
if self.debug_no_dialogue_flag:
# (If we can't prompt the user, then shut down rather than
# trying again)
return self.main_win_obj.destroy()
# Part 7 - Create sub-directories
# -------------------------------
# Create directories within the main directory directory. On failure,
# show system errors
# Create the directory for database file backups
if not os.path.isdir(self.backup_dir):
self.make_directory(self.backup_dir)
# Create the temporary data directories (or empty them, if they already
# exist)
if os.path.isdir(self.temp_dir):
self.remove_directory(self.temp_dir)
else:
self.make_directory(self.temp_dir)
if not os.path.isdir(self.temp_dl_dir):
self.make_directory(self.temp_dl_dir)
# Part 8 - Load the database file
# -------------------------------
# If the database file exists, load it. If not, create it
db_path = os.path.abspath(
os.path.join(self.data_dir, self.db_file_name),
)
if os.path.isfile(db_path):
self.load_db()
else:
# New database. First create fixed media data objects (media.Folder
# objects) that can't be removed by the user (though they can be
# hidden)
self.create_fixed_folders()
# Populate the Video Index
self.main_win_obj.video_index_populate()
# Create the database file
self.allow_db_save_flag = True
self.save_db()
# Part 9 - Warn user about failed loads
# -------------------------------------
# After a stale lockfile, when the user clicked 'No', just shut down
if self.disable_load_save_lock_flag:
return self.main_win_obj.destroy()
# If file load/save has been disabled for any other reason, we can now
# show a dialogue window
elif self.disable_load_save_flag:
# (If self.show_classic_tab_on_startup_flag is set, then the
# Classic Mode tab is visible. This looks weird, so quickly
# switch back to the Videos tab)
self.main_win_obj.notebook.set_current_page(0)
if self.disable_load_save_msg is None:
self.file_error_dialogue(
_(
'Because of an error, file load/save has been disabled',
),
)
else:
self.file_error_dialogue(
self.disable_load_save_msg + '\n\n' \
+ _(
'Because of the error, file load/save has been disabled',
)
)
# Part 10 - Start system timers
# -----------------------------
if not self.disable_load_save_flag:
# Start the script's GObject slow timer
self.script_slow_timer_id = GObject.timeout_add(
self.script_slow_timer_time,
self.script_slow_timer_callback,
)
# Start the once-only timer, calling the same function as the slow
# timer
self.script_once_timer_id = GObject.timeout_add(
self.script_once_timer_time,
self.script_slow_timer_callback,
)
# Start the script's GObject fast timer
self.script_fast_timer_id = GObject.timeout_add(
self.script_fast_timer_time,
self.script_fast_timer_callback,
)
# Part 11 - Restore pending URLs to the Classic Mode tab's textview
# -----------------------------------------------------------------
if self.classic_pending_list:
self.main_win_obj.classic_mode_tab_restore_urls(
self.classic_pending_list,
)
self.classic_pending_list = []
# Part 12 - Any scheduled download operations should start soon
# -------------------------------------------------------------
if not self.disable_load_save_flag:
# If scheduled download operation(s) are scheduled to occur on or
# some time after startup, then prepare them to start
for scheduled_obj in self.scheduled_list:
if scheduled_obj.start_mode == 'start':
# (For aesthetic reasons, the scheduled download does not
# start immediately, but a few seconds from now)
scheduled_obj.set_only_time(time.time())
elif scheduled_obj.start_mode == 'start_after':
wait_time = scheduled_obj.wait_value \
* formats.TIME_METRIC_DICT[scheduled_obj.wait_unit]
scheduled_obj.set_only_time(time.time() + wait_time)
# Part 13 - Startup complete
# -------------------------------------
# (This flag is necessary, so that Tartube can open in the system tray,
# if settings require that)
self.startup_complete_flag = False
# Part 14 - Any debug stuff can go here
# -------------------------------------
pass
def stop(self, dialogue_win=None):
"""Called by self.on_menu_quit() and
mainwin.MainWin.on_quit_menu_item().
Before terminating the Tartube app, gets confirmation from the user (if
an operation is in progress).
If no operation is in progress, calls self.stop_continue() to terminate
the app now. Otherwise, self.stop_continue() is only called when the
clicks the dialogue window's 'Yes' button.
Args:
dialogue_win (dialogue.MessageDialogue): Ignored if specified
"""
# If a (silent) livestream operation is in progress, we can stop it
# immediately
if self.livestream_manager_obj:
self.livestream_manager_obj.stop_livestream_operation()
self.stop_continue()
# If an operation is in progress, get confirmation before stopping
elif self.current_manager_obj:
if self.download_manager_obj:
string = _('There is a download operation in progress.')
elif self.update_manager_obj:
string = _('There is an update operation in progress.')
elif self.refresh_manager_obj:
string = _('There is a refresh operation in progress.')
elif self.info_manager_obj:
string = _('There is an info operation in progress.')
elif self.tidy_manager_obj:
string = _('There is a tidy operation in progress.')
elif self.process_manager_obj:
string = _('There is a process operation in progress.')
# If the user clicks 'yes', call self.stop_continue() to complete
# the shutdown
self.dialogue_manager_obj.show_msg_dialogue(
string + ' ' + _('Are you sure you want to quit Tartube?'),
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'stop_continue',
}
)
# No confirmation required, so call self.stop_continue() now
else:
self.stop_continue()
def stop_continue(self):
"""Called by self.stop() or self.download_manager_finished().
Terminates the Tartube app. Forced shutdowns (for example, by clicking
the X in the top corner of the window) are handled by
self.do_shutdown().
"""
# (No need to check the livestream operation here - it was stopped in
# the call to self.stop() )
if self.download_manager_obj:
self.download_manager_obj.stop_download_operation()
elif self.update_manager_obj:
self.update_manager_obj.stop_update_operation()
elif self.refresh_manager_obj:
self.refresh_manager_obj.stop_refresh_operation()
elif self.info_manager_obj:
self.info_manager_obj.stop_info_operation()
elif self.tidy_manager_obj:
self.tidy_manager_obj.stop_tidy_operation()
elif self.process_manager_obj:
self.process_manager_obj.stop_process_operation()
# Stop the GObject timers immediately. So this action is not repeated
# in the standard call to self.do_shutdown, reset the IVs
if self.script_slow_timer_id:
GObject.source_remove(self.script_slow_timer_id)
self.script_slow_timer_id = None
if self.script_fast_timer_id:
GObject.source_remove(self.script_fast_timer_id)
self.script_fast_timer_id = None
if self.dl_timer_id:
GObject.source_remove(self.dl_timer_id)
self.dl_timer_id = None
if self.update_timer_id:
GObject.source_remove(self.update_timer_id)
self.update_timer_id = None
if self.refresh_timer_id:
GObject.source_remove(self.refresh_timer_id)
self.refresh_timer_id = None
if self.info_timer_id:
GObject.source_remove(self.info_timer_id)
self.info_timer_id = None
if self.tidy_timer_id:
GObject.source_remove(self.tidy_timer_id)
self.tidy_timer_id = None
if self.process_timer_id:
GObject.source_remove(self.process_timer_id)
self.process_timer_id = None
# Empty any temporary folders from the database (if allowed; those
# temporary folders are always deleted when Tartube starts)
# Otherwise, open the temporary folders on the desktop, if allowd
if self.delete_on_shutdown_flag:
self.delete_temp_folders()
elif self.open_temp_on_desktop_flag:
self.open_temp_folders()
# Delete Tartube's temporary folder from the filesystem
if os.path.isdir(self.temp_dir):
self.remove_directory(self.temp_dir)
# Save the config and database files for the final time, and release
# the database lockfile
self.save_config()
self.save_db()
self.remove_db_lock_file()
# I'm outta here!
self.quit()
def system_error(self, error_code, msg):
"""Can be called by anything.
Wrapper function for mainwin.MainWin.errors_list_add_system_msg().
Args:
error_code (int): An error code in the range 100-999
msg (str): A system error message to display in the main window's
Errors List.
Notes:
Error codes for this function and for self.system_warning are
currently assigned thus:
100-199: mainapp.py (in use: 101-195)
200-299: mainwin.py (in use: 201-270)
300-399: downloads.py (in use: 301-317)
400-499: config.py (in use: 401-405)
500-599: utils.py (in use: 501-503)
600-699: info.py (in use: 601)
700-799: updates.py (in use: 701-704)
"""
if self.main_win_obj and self.system_error_show_flag:
GObject.timeout_add(
0,
self.main_win_obj.errors_list_add_system_msg,
'error',
error_code,
msg,
)
else:
# Emergency fallback: display in the terminal window
print('SYSTEM ERROR ' + str(error_code) + ': ' + msg)
def system_warning(self, error_code, msg):
"""Can be called by anything.
Wrapper function for mainwin.MainWin.errors_list_add_system_msg().
Args:
error_code (int): An error code in the range 100-999. This function
and self.system_error() share the same error codes
msg (str): A system error message to display in the main window's
Errors List.
"""
if self.main_win_obj and self.system_warning_show_flag:
GObject.timeout_add(
0,
self.main_win_obj.errors_list_add_system_msg,
'warning',
error_code,
msg,
)
else:
# Emergency fallback: display in the terminal window
print('SYSTEM WARNING ' + str(error_code) + ': ' + msg)
# (Config/database files load/save)
def load_config(self):
"""Called by self.start() (only).
Loads the Tartube config file. If loading fails, disables all file
loading/saving.
Returns:
True if this appears to be a new Tartube installation, False
otherwise (regardless of whether loading the config file
succeeds, or not)
"""
# Define global variables for this function
global _
# The config file can be stored at one of two locations, depending on
# whether xdg is available, or not
# v2.0.003 (amended v2.1.034) The user can force Tartube to use the
# config file in the script's directory (rather than the one in the
# location described by xdg) by placing a 'settings.json' file there.
# If that file is created when Tartube is already running, it can be
# an empty file (because Tartube overwrites it). Otherwise, it should
# be a copy of a legitimate config file
config_file_path = self.get_config_path()
# Sanity check
if self.current_manager_obj \
or not os.path.isfile(config_file_path) \
or self.disable_load_save_flag:
self.disable_load_save(
_(
'Failed to load the Tartube config file (failed sanity check)',
),
)
# Return False to mark this as not a new installation
return False
# In case a competing instance of Tartube is saving the same config
# file, check for the lockfile and, if it exists, wait a reasonable
# time for it to be released
if not self.debug_ignore_lockfile_flag:
lock_path = config_file_path + '.lock'
if os.path.isfile(lock_path):
check_time = time.time() + self.config_lock_time
while time.time() < check_time and os.path.isfile(lock_path):
time.sleep(0.1)
if os.path.isfile(lock_path):
self.disable_load_save(
_(
'Failed to load the Tartube config file (file is' \
+ ' locked)',
),
)
# Return False to mark this as not a new installation
return False
# Try to load the config file
try:
with open(config_file_path) as infile:
json_dict = json.load(infile)
except:
# If we're loading a config file from the script's own directory,
# then treat it as if it were a blank file, waiting to be
# overwritten by the next call to self.save_config (as described
# above)
if config_file_path == self.config_file_path:
# A blank file probably means it's a new Tartube installation.
# Return True to mark that, so the calling code can open the
# setup wizard window
return True
else:
self.disable_load_save(
_(
'Failed to load the Tartube config file (JSON load' \
+ ' failure)',
),
)
# Return False to mark this as not a new installation
return False
# Do some basic checks on the loaded data
if not json_dict \
or not 'script_name' in json_dict \
or not 'script_version' in json_dict \
or not 'save_date' in json_dict \
or not 'save_time' in json_dict \
or json_dict['script_name'] != __main__.__packagename__:
self.disable_load_save(
_(
'Failed to load the Tartube config file (file is invalid)',
),
)
# Return False to mark this as not a new installation
return False
# Convert a version, e.g. 1.234.567, into a simple number, e.g.
# 1234567, that can be compared with other versions
version = self.convert_version(json_dict['script_version'])
# Now check that the config file wasn't written by a more recent
# version of Tartube (which this older version might not be able to
# read)
if version is None \
or version > self.convert_version(__main__.__version__):
self.disable_load_save(
_(
'Failed to load the Tartube config file (file cannot be read' \
+ ' by this version)',
),
)
# Return False to mark this as not a new installation
return False
# Since v1.0.008, config files have identified their file type
if version >= 1000008 \
and (
not 'file_type' in json_dict or json_dict['file_type'] != 'config'
):
self.disable_load_save(
_(
'Failed to load the Tartube config file (missing file type)',
),
)
# Return False to mark this as not a new installation
return False
# Set the locale
if version >= 2000081: # v2.0.081
self.custom_locale = json_dict['custom_locale']
if self.custom_locale != formats.LOCALE_DEFAULT:
self.apply_locale()
# Set IVs to their new values
if version >= 2002075: # v2.2.075
self.thumb_size_custom = json_dict['thumb_size_custom']
if version >= 1004040: # v1.4.040
self.main_win_save_size_flag = json_dict['main_win_save_size_flag']
if version >= 2003018: # v2.3.018
self.main_win_save_slider_flag \
= json_dict['main_win_save_slider_flag']
if version >= 1004040: # v1.4.040
self.main_win_save_width = json_dict['main_win_save_width']
self.main_win_save_height = json_dict['main_win_save_height']
if version >= 2003018: # v2.3.018
self.main_win_videos_slider_posn \
= json_dict['main_win_videos_slider_posn']
self.main_win_progress_slider_posn \
= json_dict['main_win_progress_slider_posn']
self.main_win_classic_slider_posn \
= json_dict['main_win_classic_slider_posn']
elif version >= 1004040: # v1.4.040
# Renamed in v2.3.018
self.main_win_videos_slider_posn \
= json_dict['main_win_save_posn']
# Removed v2.3.434
# if version >= 1003122: # v1.3.122
# self.gtk_emulate_broken_flag \
# = json_dict['gtk_emulate_broken_flag']
if version >= 2001024: # v2.1.024
self.toolbar_hide_flag = json_dict['toolbar_hide_flag']
if version >= 5024: # v0.5.024
self.toolbar_squeeze_flag = json_dict['toolbar_squeeze_flag']
# (Moved to database file)
# if version >= 2002109: # v2.2.109
# self.toolbar_system_hide_flag \
# = json_dict['toolbar_system_hide_flag']
if version >= 1001064: # v1.1.064
self.show_tooltips_flag = json_dict['show_tooltips_flag']
if version >= 2003047: # v2.3.047
self.show_tooltips_extra_flag \
= json_dict['show_tooltips_extra_flag']
if version >= 2001036: # v2.1.036
self.show_custom_icons_flag \
= json_dict['show_custom_icons_flag']
if version >= 2003541: # v2.3.541
self.show_marker_in_index_flag \
= json_dict['show_marker_in_index_flag']
if version >= 2001036: # v2.1.036
self.show_small_icons_in_index_flag \
= json_dict['show_small_icons_in_index_flag']
elif version >= 1001075: # v1.1.075
self.show_small_icons_in_index_flag \
= json_dict['show_small_icons_in_index']
if version >= 1001077: # v1.1.077
self.auto_expand_video_index_flag \
= json_dict['auto_expand_video_index_flag']
if version >= 2000014: # v2.0.014
self.full_expand_video_index_flag \
= json_dict['full_expand_video_index_flag']
if version >= 1001064: # v1.1.064
self.disable_dl_all_flag = json_dict['disable_dl_all_flag']
if version >= 2003192: # v2.3.192
self.show_custom_dl_button_flag \
= json_dict['show_custom_dl_button_flag']
if version >= 2003560: # v2.3.560
self.show_free_space_flag = json_dict['show_free_space_flag']
if version >= 1004011: # v1.4.011
self.show_pretty_dates_flag = json_dict['show_pretty_dates_flag']
if version >= 2003397: # v2.3.397
self.catalogue_filter_name_flag \
= json_dict['catalogue_filter_name_flag']
self.catalogue_filter_descrip_flag \
= json_dict['catalogue_filter_descrip_flag']
self.catalogue_filter_comment_flag \
= json_dict['catalogue_filter_comment_flag']
if version >= 2002085: # v2.2.185
self.catalogue_draw_frame_flag \
= json_dict['catalogue_draw_frame_flag']
self.catalogue_draw_icons_flag \
= json_dict['catalogue_draw_icons_flag']
if version >= 2003612: # v2.3.612
self.catalogue_draw_downloaded_flag \
= json_dict['catalogue_draw_downloaded_flag']
self.catalogue_draw_undownloaded_flag \
= json_dict['catalogue_draw_undownloaded_flag']
if version >= 2003481: # v2.3.481
self.catalogue_draw_blocked_flag \
= json_dict['catalogue_draw_blocked_flag']
if version >= 2003232: # v2.3.232
self.catalogue_clickable_container_flag \
= json_dict['catalogue_clickable_container_flag']
if version >= 2004025: # v2.4.025
self.catalogue_show_nickname_flag \
= json_dict['catalogue_show_nickname_flag']
if version >= 2002028: # v2.2.128
self.drag_video_path_flag = json_dict['drag_video_path_flag']
self.drag_video_source_flag = json_dict['drag_video_source_flag']
self.drag_video_name_flag = json_dict['drag_video_name_flag']
if version >= 2002162: # v2.2.162
self.drag_thumb_path_flag = json_dict['drag_thumb_path_flag']
if version >= 1003024: # v1.3.024
self.show_status_icon_flag = json_dict['show_status_icon_flag']
if version >= 2003504: # v1.3.504
self.open_in_tray_flag = json_dict['open_in_tray_flag']
if version >= 1003024: # v1.3.024
self.close_to_tray_flag = json_dict['close_to_tray_flag']
if version >= 2003125: # v2.3.125
self.restore_posn_from_tray_flag \
= json_dict['restore_posn_from_tray_flag']
if version >= 1003129: # v1.3.129
self.progress_list_hide_flag = json_dict['progress_list_hide_flag']
if version >= 1000029: # v1.0.029
self.results_list_reverse_flag \
= json_dict['results_list_reverse_flag']
if version >= 1003069: # v1.3.069
self.system_error_show_flag = json_dict['system_error_show_flag']
if version >= 6006: # v0.6.006
self.system_warning_show_flag \
= json_dict['system_warning_show_flag']
if version >= 1003079: # v1.3.079
self.operation_error_show_flag \
= json_dict['operation_error_show_flag']
self.operation_warning_show_flag \
= json_dict['operation_warning_show_flag']
if version >= 2003116: # v2.3.116
self.system_msg_show_date_flag \
= json_dict['system_msg_show_date_flag']
if version >= 2003513: # v2.3.513
self.system_msg_show_container_flag \
= json_dict['system_msg_show_container_flag']
self.system_msg_show_video_flag \
= json_dict['system_msg_show_video_flag']
self.system_msg_show_multi_line_flag \
= json_dict['system_msg_show_multi_line_flag']
if version >= 1000007: # v1.0.007
self.system_msg_keep_totals_flag \
= json_dict['system_msg_keep_totals_flag']
self.data_dir = json_dict['data_dir']
if version >= 1004069: # v1.4.069:
self.data_dir_alt_list = json_dict['data_dir_alt_list']
self.data_dir_use_first_flag = json_dict['data_dir_use_first_flag']
self.data_dir_use_list_flag = json_dict['data_dir_use_list_flag']
self.data_dir_add_from_list_flag \
= json_dict['data_dir_add_from_list_flag']
else:
self.data_dir_alt_list = [ self.data_dir ]
if version >= 2000069: # v2.0.069:
self.sound_custom = json_dict['sound_custom']
if version >= 2003214: # v2.3.214
self.export_csv_separator = json_dict['export_csv_separator']
if version >= 3014: # v0.3.014
self.db_backup_mode = json_dict['db_backup_mode']
if version >= 2000029: # v2.0.029
self.show_classic_tab_on_startup_flag \
= json_dict['show_classic_tab_on_startup_flag']
if version >= 2002164: # v2.2.164
self.classic_custom_dl_flag = json_dict['classic_custom_dl_flag']
if version >= 2000029: # v2.0.029
self.classic_dir_list = json_dict['classic_dir_list']
self.classic_dir_previous = json_dict['classic_dir_previous']
if version >= 2003190: # v2.3.190
# (Before v2.3.369, this values was stored with leading zeroes)
self.classic_format_selection \
= utils.strip_whitespace(json_dict['classic_format_selection'])
self.classic_format_convert_flag \
= json_dict['classic_format_convert_flag']
if version >= 2003473: # v2.3.473
self.classic_resolution_selection \
= json_dict['classic_resolution_selection']
if version >= 2003586: # v2.3.586
self.classic_livestream_flag = json_dict['classic_livestream_flag']
if version >= 2002129: # v2.2.129
self.classic_pending_flag = json_dict['classic_pending_flag']
self.classic_pending_list = json_dict['classic_pending_list']
if version >= 2003046: # v2.3.046
self.classic_duplicate_remove_flag \
= json_dict['classic_duplicate_remove_flag']
# (In various versions between v0.5.027 and v2.0.097, the youtube
# update IVs were overhauled several times)
self.load_config_ytdl_update(version, json_dict)
if version >= 2001086: # v2.1.086:
self.auto_switch_output_flag = json_dict['auto_switch_output_flag']
if version >= 2002043: # v2.2.043:
self.output_size_default = json_dict['output_size_default']
self.output_size_apply_flag = json_dict['output_size_apply_flag']
if version >= 2001117: # v2.1.117:
self.ytdl_update_once_flag = json_dict['ytdl_update_once_flag']
else:
# Don't auto-detect youtube-dl if this installation is not the
# first one (as the user won't be expecting that)
self.ytdl_update_once_flag = True
if version >= 2003182: # v2.3.182:
self.ytdl_fork_no_dependency_flag \
= json_dict['ytdl_fork_no_dependency_flag']
if version >= 1003074: # v1.3.074
self.ytdl_output_system_cmd_flag \
= json_dict['ytdl_output_system_cmd_flag']
if version >= 1002030: # v1.2.030
self.ytdl_output_stdout_flag = json_dict['ytdl_output_stdout_flag']
self.ytdl_output_ignore_json_flag \
= json_dict['ytdl_output_ignore_json_flag']
self.ytdl_output_ignore_progress_flag \
= json_dict['ytdl_output_ignore_progress_flag']
self.ytdl_output_stderr_flag = json_dict['ytdl_output_stderr_flag']
self.ytdl_output_start_empty_flag \
= json_dict['ytdl_output_start_empty_flag']
if version >= 1003064: # v1.3.064
self.ytdl_output_show_summary_flag \
= json_dict['ytdl_output_show_summary_flag']
if version >= 1003074: # v1.3.074
self.ytdl_write_system_cmd_flag \
= json_dict['ytdl_write_system_cmd_flag']
self.ytdl_write_stdout_flag = json_dict['ytdl_write_stdout_flag']
if version >= 5004: # v0.5.004
self.ytdl_write_ignore_json_flag \
= json_dict['ytdl_write_ignore_json_flag']
if version >= 1002030: # v1.2.030
self.ytdl_write_ignore_progress_flag \
= json_dict['ytdl_write_ignore_progress_flag']
self.ytdl_write_stderr_flag = json_dict['ytdl_write_stderr_flag']
self.ytdl_write_verbose_flag = json_dict['ytdl_write_verbose_flag']
# Removed v2.3.565
# if version >= 2002179: # v2.2.179
# self.ytsc_write_verbose_flag = json_dict['ytsc_write_verbose_flag']
if version >= 1002024: # v1.2.024
self.refresh_output_videos_flag \
= json_dict['refresh_output_videos_flag']
if version >= 1002027: # v1.2.027
self.refresh_output_verbose_flag \
= json_dict['refresh_output_verbose_flag']
if version >= 1003012: # v1.3.012
self.refresh_moviepy_timeout = json_dict['refresh_moviepy_timeout']
if version >= 1002030: # v1.2.037
self.disk_space_warn_flag = json_dict['disk_space_warn_flag']
self.disk_space_warn_limit = json_dict['disk_space_warn_limit']
self.disk_space_stop_flag = json_dict['disk_space_stop_flag']
self.disk_space_stop_limit = json_dict['disk_space_stop_limit']
if version < 2003556: # v2.3.556
# (In this version, values changed from MB to GB)
self.disk_space_warn_limit \
= round((self.disk_space_warn_limit / 1000), 3)
self.disk_space_stop_limit \
= round((self.disk_space_stop_limit / 1000), 3)
if version >= 2001094: # v2.1.094
self.custom_invidious_mirror = json_dict['custom_invidious_mirror']
if version >= 2003236: # v2.3.236
self.custom_sblock_mirror = json_dict['custom_sblock_mirror']
# (Moved to database file)
# if version >= 1004024: # v1.4.024
# self.custom_dl_by_video_flag \
# = json_dict['custom_dl_by_video_flag']
# if version >= 2003155: # v2.3.155
# self.custom_dl_split_flag = json_dict['custom_dl_split_flag']
# if version >= 2003240: # v2.3.240
# self.custom_dl_slice_flag = json_dict['custom_dl_slice_flag']
# self.custom_dl_slice_dict = json_dict['custom_dl_slice_dict']
# (Moved to database file)
# if version >= 1004052: # v1.4.052
# self.custom_dl_divert_mode = json_dict['custom_dl_divert_mode']
# elif version >= 1004024: # v1.4.024
# if json_dict['custom_dl_divert_hooktube_flag']:
# self.custom_dl_divert_mode = 'hooktube'
# if version >= 2001047: # v2.1.047
# self.custom_dl_divert_website \
# = json_dict['custom_dl_divert_website']
# if version >= 1004024: # v1.4.024
# self.custom_dl_delay_flag = json_dict['custom_dl_delay_flag']
# self.custom_dl_delay_max = json_dict['custom_dl_delay_max']
# self.custom_dl_delay_min = json_dict['custom_dl_delay_min']
if version >= 2003029: # v2.3.029
self.dl_proxy_list = json_dict['dl_proxy_list']
if version >= 1001054: # v1.1.054
self.ffmpeg_path = json_dict['ffmpeg_path']
if version >= 2001095: # v2.1.095
self.avconv_path = json_dict['avconv_path']
else:
# (Before this version, .ffmpeg_path was used for the avconv binary
# too)
if self.ffmpeg_path is not None \
and re.search(r'avconv', self.ffmpeg_path):
self.avconv_path = self.ffmpeg_path
self.ffmpeg_path = None
if version >= 2001098: # v2.1.098
self.ffmpeg_convert_webp_flag \
= json_dict['ffmpeg_convert_webp_flag']
if version >= 2003566: # v2.3.566
self.livestream_dl_mode = json_dict['livestream_dl_mode']
if version >= 2003619: # v2.3.619
self.livestream_dl_timeout = json_dict['livestream_dl_timeout']
if version >= 2003582: # v2.3.582
self.livestream_replace_flag = json_dict['livestream_replace_flag']
self.livestream_stop_is_final_flag \
= json_dict['livestream_stop_is_final_flag']
self.livestream_force_check_flag \
= json_dict['livestream_force_check_flag']
# Removed v2.3.565
# if version >= 2002178: # v2.2.178
# self.ytsc_path = json_dict['ytsc_path']
# if version >= 2002181: # v2.2.181
# self.ytsc_path = json_dict['ytsc_path']
# self.ytsc_priority_flag = json_dict['ytsc_priority_flag']
# self.ytsc_wait_time = json_dict['ytsc_wait_time']
# self.ytsc_restart_max = json_dict['ytsc_restart_max']
if version >= 2003570: # v2.3.570
self.streamlink_path = json_dict['streamlink_path']
# Removed v2.2.156
# if version >= 2001104: # v2.1.104
# self.ffmpeg_add_string = json_dict['ffmpeg_add_string']
# self.ffmpeg_regex_string = json_dict['ffmpeg_regex_string']
# self.ffmpeg_substitute_string \
# = json_dict['ffmpeg_substitute_string']
# self.ffmpeg_ext_string = json_dict['ffmpeg_ext_string']
# self.ffmpeg_option_string = json_dict['ffmpeg_option_string']
# self.ffmpeg_delete_flag = json_dict['ffmpeg_delete_flag']
# self.ffmpeg_keep_flag = json_dict['ffmpeg_keep_flag']
if version >= 2003067: # v2.3.067
self.graph_data_type = json_dict['graph_data_type']
self.graph_plot_type = json_dict['graph_plot_type']
self.graph_time_period_secs = json_dict['graph_time_period_secs']
self.graph_time_unit_secs = json_dict['graph_time_unit_secs']
self.graph_ink_colour = json_dict['graph_ink_colour']
if version >= 3029: # v0.3.029
self.operation_limit_flag = json_dict['operation_limit_flag']
self.operation_check_limit = json_dict['operation_check_limit']
self.operation_download_limit \
= json_dict['operation_download_limit']
if version >= 2003114: # v2.3.114
self.show_newbie_dialogue_flag \
= json_dict['show_newbie_dialogue_flag']
if version >= 2003376: # v2.3.376
self.show_msys2_dialogue_flag \
= json_dict['show_msys2_dialogue_flag']
if version >= 2004062: # v2.4.062
self.show_delete_video_dialogue_flag \
= json_dict['show_delete_video_dialogue_flag']
self.delete_video_files_flag \
= json_dict['delete_video_files_flag']
self.show_delete_container_dialogue_flag \
= json_dict['show_delete_container_dialogue_flag']
self.delete_container_files_flag \
= json_dict['delete_container_files_flag']
if version >= 2004013: # v2.4.013
self.auto_switch_profile_flag \
= json_dict['auto_switch_profile_flag']
if version >= 1003032: # v1.3.032
self.auto_clone_options_flag = json_dict['auto_clone_options_flag']
if version >= 2002116: # v2.2.116
self.auto_delete_options_flag \
= json_dict['auto_delete_options_flag']
if version >= 1002013: # v1.2.013
self.simple_options_flag = json_dict['simple_options_flag']
# Removed v2.2.015
# if version >= 1001067: # v1.0.067
# self.scheduled_dl_mode = json_dict['scheduled_dl_mode']
# self.scheduled_check_mode = json_dict['scheduled_check_mode']
#
# # Renamed in v2.1.056
# if 'scheduled_dl_wait_value' in json_dict:
# self.scheduled_dl_wait_value \
# = json_dict['scheduled_dl_wait_value']
# self.scheduled_dl_wait_unit \
# = json_dict['scheduled_dl_wait_unit']
# self.scheduled_check_wait_value \
# = json_dict['scheduled_check_wait_value']
# self.scheduled_check_wait_unit \
# = json_dict['scheduled_check_wait_unit']
# else:
# self.scheduled_dl_wait_value \
# = json_dict['scheduled_dl_wait_hours']
# self.scheduled_dl_wait_unit = 'hours'
# self.scheduled_check_wait_value \
# = json_dict['scheduled_check_wait_hours']
# self.scheduled_check_wait_unit = 'hours'
#
# self.scheduled_dl_last_time \
# = json_dict['scheduled_dl_last_time']
# self.scheduled_check_last_time \
# = json_dict['scheduled_check_last_time']
#
# # Renamed in v1.3.120
# if 'scheduled_stop_flag' in json_dict:
# self.scheduled_shutdown_flag \
# = json_dict['scheduled_stop_flag']
# else:
# self.scheduled_shutdown_flag \
# = json_dict['scheduled_shutdown_flag']
#
# if version >= 2001110: # v2.1.110
# self.scheduled_custom_mode = json_dict['scheduled_custom_mode']
# self.scheduled_custom_wait_value \
# = json_dict['scheduled_custom_wait_value']
# self.scheduled_custom_wait_unit \
# = json_dict['scheduled_custom_wait_unit']
# self.scheduled_custom_last_time \
# = json_dict['scheduled_custom_last_time']
# Import scheduled downloads created before v2.2.015, and convert them
# to the new media.Scheduled objects
if version < 2002015: # v2.2.015
self.load_config_import_scheduled(version, json_dict)
if version >= 2004085: # v2.4.085
self.block_livestreams_flag = json_dict['block_livestreams_flag']
if version >= 2000037: # v2.0.037
self.enable_livestreams_flag = json_dict['enable_livestreams_flag']
if version >= 2000047: # v2.0.047
self.livestream_max_days = json_dict['livestream_max_days']
self.livestream_use_colour_flag \
= json_dict['livestream_use_colour_flag']
if version >= 2002204: # v2.2.204
self.livestream_simple_colour_flag \
= json_dict['livestream_simple_colour_flag']
if version >= 2000052: # v2.0.052
self.livestream_auto_notify_flag \
= json_dict['livestream_auto_notify_flag']
if version >= 2000068: # v2.0.068
self.livestream_auto_alarm_flag \
= json_dict['livestream_auto_alarm_flag']
if version >= 2000052: # v2.0.052
self.livestream_auto_open_flag \
= json_dict['livestream_auto_open_flag']
if version >= 2000054: # v2.0.054
self.livestream_auto_dl_start_flag \
= json_dict['livestream_auto_dl_start_flag']
self.livestream_auto_dl_stop_flag \
= json_dict['livestream_auto_dl_stop_flag']
if version >= 2000037: # v2.0.037
self.scheduled_livestream_flag \
= json_dict['scheduled_livestream_flag']
self.scheduled_livestream_wait_mins \
= json_dict['scheduled_livestream_wait_mins']
self.scheduled_livestream_last_time \
= json_dict['scheduled_livestream_last_time']
if version >= 2002108: # v2.2.108
self.scheduled_livestream_extra_flag \
= json_dict['scheduled_livestream_extra_flag']
if version >= 1003112: # v1.3.112
self.autostop_time_flag = json_dict['autostop_time_flag']
self.autostop_time_value = json_dict['autostop_time_value']
self.autostop_time_unit = json_dict['autostop_time_unit']
self.autostop_videos_flag = json_dict['autostop_videos_flag']
self.autostop_videos_value = json_dict['autostop_videos_value']
self.autostop_size_flag = json_dict['autostop_size_flag']
self.autostop_size_value = json_dict['autostop_size_value']
self.autostop_size_unit = json_dict['autostop_size_unit']
self.operation_auto_update_flag \
= json_dict['operation_auto_update_flag']
self.operation_save_flag = json_dict['operation_save_flag']
if version >= 1004003: # v1.4.003
self.operation_sim_shortcut_flag \
= json_dict['operation_sim_shortcut_flag']
if version >= 2002112: # v2.2.112
self.operation_auto_restart_flag \
= json_dict['operation_auto_restart_flag']
self.operation_auto_restart_time \
= json_dict['operation_auto_restart_time']
# Removed v2.3.461
# if version >= 2003012: # v2.3.012
# self.operation_auto_restart_network_flag \
# = json_dict['operation_auto_restart_network_flag']
if version >= 2002169: # v2.2.169
self.operation_auto_restart_max \
= json_dict['operation_auto_restart_max']
# Removed v1.3.028
# self.operation_dialogue_flag = json_dict['operation_dialogue_flag']
if version >= 1003028: # v1.3.028
self.operation_dialogue_mode = json_dict['operation_dialogue_mode']
if version >= 1003060: # v1.3.060
self.operation_convert_mode = json_dict['operation_convert_mode']
self.use_module_moviepy_flag = json_dict['use_module_moviepy_flag']
# Removed v0.5.003
# self.use_module_validators_flag \
# = json_dict['use_module_validators_flag']
if version >= 1000006: # v1.0.006
self.dialogue_copy_clipboard_flag \
= json_dict['dialogue_copy_clipboard_flag']
self.dialogue_keep_open_flag \
= json_dict['dialogue_keep_open_flag']
# Removed v1.3.022
# self.dialogue_keep_container_flag \
# = json_dict['dialogue_keep_container_flag']
if version >= 2003130: # v2.3.130
self.dialogue_yt_remind_flag = json_dict['dialogue_yt_remind_flag']
if version >= 2003371: # v2.3.371
self.dialogue_disable_msg_flag \
= json_dict['dialogue_disable_msg_flag']
if version >= 1003018: # v1.3.018
self.allow_ytdl_archive_flag \
= json_dict['allow_ytdl_archive_flag']
if version >= 2003401: # v2.3.401
self.allow_ytdl_archive_mode \
= json_dict['allow_ytdl_archive_mode']
self.allow_ytdl_archive_path \
= json_dict['allow_ytdl_archive_path']
if version >= 2001022: # v2.1.022
self.classic_ytdl_archive_flag \
= json_dict['classic_ytdl_archive_flag']
if version >= 5004: # v0.5.004
self.apply_json_timeout_flag \
= json_dict['apply_json_timeout_flag']
if version >= 2003551: # v2.3.551
self.json_timeout_no_comments_time \
= json_dict['json_timeout_no_comments_time']
self.json_timeout_with_comments_time \
= json_dict['json_timeout_with_comments_time']
if version >= 2001060: # v2.1.060
self.track_missing_videos_flag \
= json_dict['track_missing_videos_flag']
self.track_missing_time_flag \
= json_dict['track_missing_time_flag']
self.track_missing_time_days \
= json_dict['track_missing_time_days']
if version >= 2003464: # v2.3.464
self.add_blocked_videos_flag \
= json_dict['add_blocked_videos_flag']
if version >= 2003382: # v2.3.382
self.store_playlist_id_flag \
= json_dict['store_playlist_id_flag']
if version >= 2003181: # v2.3.181
self.video_timestamps_extract_json_flag \
= json_dict['video_timestamps_extract_json_flag']
self.video_timestamps_extract_descrip_flag \
= json_dict['video_timestamps_extract_descrip_flag']
self.video_timestamps_replace_flag \
= json_dict['video_timestamps_replace_flag']
self.video_timestamps_re_extract_flag \
= json_dict['video_timestamps_re_extract_flag']
self.split_video_name_mode = json_dict['split_video_name_mode']
self.split_video_clips_dir_flag \
= json_dict['split_video_clips_dir_flag']
self.split_video_subdir_flag = json_dict['split_video_subdir_flag']
self.split_video_add_db_flag = json_dict['split_video_add_db_flag']
self.split_video_copy_thumb_flag \
= json_dict['split_video_copy_thumb_flag']
self.split_video_custom_title \
= json_dict['split_video_custom_title']
self.split_video_auto_open_flag \
= json_dict['split_video_auto_open_flag']
self.split_video_auto_delete_flag \
= json_dict['split_video_auto_delete_flag']
if version >= 2003236: # v2.3.236
self.sblock_fetch_flag = json_dict['sblock_fetch_flag']
self.sblock_obfuscate_flag = json_dict['sblock_obfuscate_flag']
if version >= 2003257: # v2.3.257
self.sblock_replace_flag = json_dict['sblock_replace_flag']
self.sblock_re_extract_flag = json_dict['sblock_re_extract_flag']
if version >= 2003250: # v2.3.250
self.slice_video_cleanup_flag \
= json_dict['slice_video_cleanup_flag']
if version < 2003552: # v2.3.552
self.check_comment_fetch_flag = json_dict['comment_fetch_flag']
self.dl_comment_fetch_flag = json_dict['comment_fetch_flag']
else:
self.check_comment_fetch_flag \
= json_dict['check_comment_fetch_flag']
self.dl_comment_fetch_flag = json_dict['dl_comment_fetch_flag']
if version >= 2003316: # v2.3.316
self.comment_store_flag = json_dict['comment_store_flag']
if version >= 2003318: # v2.3.318
self.comment_show_text_time_flag \
= json_dict['comment_show_text_time_flag']
if version >= 2003319: # v2.3.319
self.comment_show_formatted_flag \
= json_dict['comment_show_formatted_flag']
if version >= 5004: # v0.5.004
self.ignore_child_process_exit_flag \
= json_dict['ignore_child_process_exit_flag']
if version >= 1003088: # v1.3.088
self.ignore_http_404_error_flag \
= json_dict['ignore_http_404_error_flag']
self.ignore_data_block_error_flag \
= json_dict['ignore_data_block_error_flag']
if version >= 1027: # v0.1.028
self.ignore_merge_warning_flag \
= json_dict['ignore_merge_warning_flag']
if version >= 1003088: # v1.3.088
self.ignore_missing_format_error_flag \
= json_dict['ignore_missing_format_error_flag']
if version >= 1001077: # v1.1.077
self.ignore_no_annotations_flag \
= json_dict['ignore_no_annotations_flag']
if version >= 1002004: # v1.2.004
self.ignore_no_subtitles_flag \
= json_dict['ignore_no_subtitles_flag']
if version >= 2003340: # v2.3.340
self.ignore_page_given_flag = json_dict['ignore_page_given_flag']
self.ignore_no_descrip_flag = json_dict['ignore_no_descrip_flag']
if version >= 2003403: # v2.3.403
self.ignore_thumb_404_flag = json_dict['ignore_thumb_404_flag']
if version >= 5004: # v0.5.004
self.ignore_yt_copyright_flag \
= json_dict['ignore_yt_copyright_flag']
if version >= 1003084: # v1.3.084
self.ignore_yt_age_restrict_flag \
= json_dict['ignore_yt_age_restrict_flag']
if version >= 1003088: # v1.3.088
self.ignore_yt_uploader_deleted_flag \
= json_dict['ignore_yt_uploader_deleted_flag']
if version >= 2002025: # v2.2.025
self.ignore_yt_payment_flag \
= json_dict['ignore_yt_payment_flag']
if version >= 1003090: # v1.3.090
self.ignore_custom_msg_list \
= json_dict['ignore_custom_msg_list']
self.ignore_custom_regex_flag \
= json_dict['ignore_custom_regex_flag']
self.num_worker_default = json_dict['num_worker_default']
self.num_worker_apply_flag = json_dict['num_worker_apply_flag']
if version >= 2002184: # v2.2.184
self.num_worker_bypass_flag = json_dict['num_worker_bypass_flag']
self.bandwidth_default = json_dict['bandwidth_default']
self.bandwidth_apply_flag = json_dict['bandwidth_apply_flag']
if version >= 1002011: # v1.2.011
self.video_res_default = json_dict['video_res_default']
self.video_res_apply_flag = json_dict['video_res_apply_flag']
if version >= 2003117: # v2.3.117
self.alt_num_worker = json_dict['alt_num_worker']
self.alt_num_worker_apply_flag \
= json_dict['alt_num_worker_apply_flag']
self.alt_bandwidth = json_dict['alt_bandwidth']
self.alt_bandwidth_apply_flag \
= json_dict['alt_bandwidth_apply_flag']
self.alt_start_time = json_dict['alt_start_time']
self.alt_stop_time = json_dict['alt_stop_time']
self.alt_day_string = json_dict['alt_day_string']
self.match_method = json_dict['match_method']
self.match_first_chars = json_dict['match_first_chars']
self.match_ignore_chars = json_dict['match_ignore_chars']
if version >= 1001029: # v1.1.029
self.auto_delete_flag = json_dict['auto_delete_flag']
self.auto_delete_days = json_dict['auto_delete_days']
if version >= 2003609: # v2.3.609
self.auto_remove_flag = json_dict['auto_remove_flag']
self.auto_remove_days = json_dict['auto_remove_days']
if version >= 1001029: # v1.1.029
self.auto_delete_watched_flag \
= json_dict['auto_delete_watched_flag']
if version >= 2003610: # v2.3.610
self.auto_delete_asap_flag = json_dict['auto_delete_asap_flag']
if version >= 1002041: # v1.2.041
self.delete_on_shutdown_flag = json_dict['delete_on_shutdown_flag']
if version >= 1004027: # v1.4.027
self.open_temp_on_desktop_flag \
= json_dict['open_temp_on_desktop_flag']
self.complex_index_flag = json_dict['complex_index_flag']
if version >= 3019: # v0.3.019
self.catalogue_mode = json_dict['catalogue_mode']
if version >= 2002069: # v2.2.069
self.catalogue_mode_type = json_dict['catalogue_mode_type']
if version >= 3023: # v0.3.023
self.catalogue_page_size = json_dict['catalogue_page_size']
if version >= 1004005: # v1.4.005
self.catalogue_show_filter_flag \
= json_dict['catalogue_show_filter_flag']
if version >= 1004005 and version < 2002159: # v1.4.005, v2.2.159
catalogue_alpha_sort_flag = json_dict['catalogue_alpha_sort_flag']
if not catalogue_alpha_sort_flag:
self.catalogue_sort_mode = 'default'
else:
self.catalogue_sort_mode = 'alpha'
elif version >= 2002159: # v2.2.159
self.catalogue_sort_mode \
= json_dict['catalogue_sort_mode']
if version >= 1004005: # v1.4.005
self.catologue_use_regex_flag \
= json_dict['catologue_use_regex_flag']
if version >= 2003129: # v2.3.129
self.url_change_confirm_flag = json_dict['url_change_confirm_flag']
self.url_change_regex_flag = json_dict['url_change_regex_flag']
if version >= 2003195: # v2.3.195
self.custom_bg_table = json_dict['custom_bg_table']
if version < 2003537: # v2.3.537
# (New key-value pairs added)
for key in [
'drag_drop_notify', 'drag_drop_odd', 'drag_drop_even',
]:
self.custom_bg_table[key] = self.default_bg_table[key]
if version >= 2003230: # v2.3.230
self.ytdlp_filter_options_flag \
= json_dict['ytdlp_filter_options_flag']
# Having loaded the config file, set various file paths...
if self.data_dir_use_first_flag and self.data_dir_alt_list:
self.data_dir = self.data_dir_alt_list[0]
self.update_data_dirs()
# Set custom background colours for the Video Catalogue
for key in self.custom_bg_table:
self.main_win_obj.setup_bg_colour(key)
# If the most-recently selected directory, self.classic_dir_previous,
# still exists in self.classic_dir_list, move it to the top, so it's
# the first item displayed in the combo
if self.classic_dir_previous is not None \
and self.classic_dir_previous in self.classic_dir_list:
self.classic_dir_list.remove(self.classic_dir_previous)
self.classic_dir_list.insert(0, self.classic_dir_previous)
# In either case, we don't need to remember the previous session's
# destination directory any more
self.classic_dir_previous = None
# Return False to mark this as not a new installation
return False
def load_config_ytdl_update(self, version, json_dict):
""""Called by self.load_config().
The IVs handling youtube-dl updates have been overhauled several
times.
To keep the layout of self.load_config() reasonable, this function is
called to import the IVs from the loaded config file, and update them
as appropriate.
Args:
version (int): The config file's Tartube version, converted to a
simple integer in a call to self.convert_version()
json_dict: The data loaded from the config file
"""
# (In version v0.5.027, the value of these IVs were overhauled. If
# loading from an earlier config file, replace those values with the
# new default values)
if version >= 5027:
self.ytdl_bin = json_dict['ytdl_bin']
self.ytdl_path_default = json_dict['ytdl_path_default']
self.ytdl_path = json_dict['ytdl_path']
self.ytdl_update_dict = json_dict['ytdl_update_dict']
self.ytdl_update_list = json_dict['ytdl_update_list']
self.ytdl_update_current = json_dict['ytdl_update_current']
# (In version v1.3.903, these IVs were modified a little, but not
# on MS Windows)
if os.name != 'nt' and version <= 1003090: # v1.3.090
self.ytdl_update_dict['Update using pip3 (recommended)'] \
= ['pip3', 'install', '--upgrade', '--user', 'youtube-dl']
self.ytdl_update_dict['Update using pip3 (omit --user option)'] \
= ['pip3', 'install', '--upgrade', 'youtube-dl']
self.ytdl_update_dict['Update using pip'] \
= ['pip', 'install', '--upgrade', '--user', 'youtube-dl']
self.ytdl_update_dict['Update using pip (omit --user option)'] \
= ['pip', 'install', '--upgrade', 'youtube-dl']
self.ytdl_update_list = [
'Update using pip3 (recommended)',
'Update using pip3 (omit --user option)',
'Update using pip',
'Update using pip (omit --user option)',
'Update using default youtube-dl path',
'Update using local youtube-dl path',
]
# (In version v1.5.012, these IVs were modified a little, but not on
# MS Windows)
if os.name != 'nt' and version <= 1005012: # v1.5.012
self.ytdl_update_dict['Update using PyPI youtube-dl path'] \
= [self.ytdl_path_pypi, '-U']
self.ytdl_update_list.append('Update using PyPI youtube-dl path')
# (In version v2.0.086, these IVs were completely overhauled on all
# operating systems)
if version < 2000096: # v2.0.096
update_dict = {
'Update using default youtube-dl path':
'ytdl_update_default_path',
'Update using local youtube-dl path':
'ytdl_update_local_path',
'Update using pip':
'ytdl_update_pip',
'Update using pip (omit --user option)':
'ytdl_update_pip_omit_user',
'Update using pip3':
'ytdl_update_pip3',
'Update using pip3 (omit --user option)':
'ytdl_update_pip3_omit_user',
'Update using pip3 (recommended)':
'ytdl_update_pip3_recommend',
'Update using PyPI youtube-dl path':
'ytdl_update_pypi_path',
'Windows 32-bit update (recommended)':
'ytdl_update_win_32',
'Windows 64-bit update (recommended)':
'ytdl_update_win_64',
'youtube-dl updates are disabled':
'ytdl_update_disabled',
}
ytdl_update_dict = {}
for key in self.ytdl_update_dict:
ytdl_update_dict[update_dict[key]] = self.ytdl_update_dict[key]
self.ytdl_update_dict = ytdl_update_dict
ytdl_update_list = []
for item in self.ytdl_update_list:
ytdl_update_list.append(update_dict[item])
self.ytdl_update_list = ytdl_update_list
self.ytdl_update_current = update_dict[self.ytdl_update_current]
# (In version v2.0.109, the directory location used by tartube_mswin.sh
# was changed)
if version < 2000109 and os.name == 'nt': # v2.0.109
if 'PROGRAMFILES(X86)' in os.environ:
recommended = 'ytdl_update_win_64'
else:
recommended = 'ytdl_update_win_32'
recommended_list = self.ytdl_update_dict[recommended]
mod_list = []
for item in recommended_list:
mod_list.append(re.sub(r'^..\\', '', item))
self.ytdl_update_dict[recommended] = mod_list
# (In version v2.1.083, added support for youtube-dl forks)
if version >= 2001083:
self.ytdl_fork = json_dict['ytdl_fork']
# (In version v2.3.082, these IVs were modified a little on all
# systems)
if version < 2003082: # v2.3.082
self.ytdl_update_dict['ytdl_update_custom_path'] \
= ['python3', self.ytdl_path, '-U']
self.ytdl_update_list.insert(
(len(self.ytdl_update_list) - 1),
'ytdl_update_custom_path',
)
else:
self.ytdl_path_custom_flag = json_dict['ytdl_path_custom_flag']
# (In version v2.3.183, self.ytdl_update_dict was modified again)
if version < 2003183: # v2.3.183
self.ytdl_update_dict['ytdl_update_pip_no_dependencies'] = [
'pip', 'install', '--upgrade', '--no-dependencies',
'youtube-dl',
]
self.ytdl_update_dict['ytdl_update_pip3_no_dependencies'] = [
'pip3', 'install', '--upgrade', '--no-dependencies',
'youtube-dl',
]
ytdl_update_list = []
for item in self.ytdl_update_list:
if item == 'ytdl_update_pip':
ytdl_update_list.append('ytdl_update_pip_no_dependencies')
elif item == 'ytdl_update_pip3':
ytdl_update_list.append('ytdl_update_pip3_no_dependencies')
ytdl_update_list.append(item)
self.ytdl_update_list = ytdl_update_list
# (In version v2.3.277, self.ytdl_update_dict was modified yet again)
if version < 2003277: # v2.3.277
if os.name == 'nt' and 'PROGRAMFILES(X86)' in os.environ:
self.ytdl_update_dict['ytdl_update_win_64_no_dependencies'] = [
'..\\..\\..\\mingw64\\bin\python3.exe',
'..\\..\\..\\mingw64\\bin\pip3-script.py',
'install',
'--upgrade',
'--no-dependencies',
'youtube-dl',
]
elif os.name == 'nt' and not 'PROGRAMFILES(X86)' in os.environ:
self.ytdl_update_dict['ytdl_update_win_64_no_dependencies'] = [
'..\\..\\..\\mingw32\\bin\python3.exe',
'..\\..\\..\\mingw32\\bin\pip3-script.py',
'install',
'-upgrade',
'--no-dependencies',
'youtube-dl',
]
ytdl_update_list = []
for item in self.ytdl_update_list:
ytdl_update_list.append(item)
if item == 'ytdl_update_win_64':
ytdl_update_list.append(
'ytdl_update_win_64_no_dependencies',
)
elif item == 'ytdl_update_win_32':
ytdl_update_list.append(
'ytdl_update_win_32_no_dependencies',
)
self.ytdl_update_list = ytdl_update_list
def load_config_import_scheduled(self, version, json_dict):
""""Called by self.load_config().
Since v2.2.015, scheduled downloads have been handled by
media.Scheduled objects. stored in the database file. Before that, they
were handled by a set of IVs stored in the config file.
This function is called when reading a config file for earlier
versions. It extracts the values of the old scheduled download IVs,
and then converts them to media.Scheduled objects (so any scheduled
downloads will happen as normal, without the user needing to do
anything).
Args:
version (int): The config file's Tartube version, converted to a
simple integer in a call to self.convert_version()
json_dict: The data loaded from the config file
"""
# Set up variables whose values are the default values of the old IVs
scheduled_check_mode = 'disabled'
scheduled_check_wait_value = 2
scheduled_check_wait_unit = 'hours'
scheduled_check_last_time = 0
scheduled_dl_mode = 'disabled'
scheduled_dl_wait_value = 2
scheduled_dl_wait_unit = 'hours'
scheduled_dl_last_time = 0
scheduled_custom_mode = 'disabled'
scheduled_custom_wait_value = 2
scheduled_custom_wait_unit = 'hours'
scheduled_custom_last_time = 0
scheduled_shutdown_flag = False
# Now update those values from the config file
if version >= 1001067: # v1.0.067
scheduled_dl_mode = json_dict['scheduled_dl_mode']
scheduled_check_mode = json_dict['scheduled_check_mode']
# Renamed in v2.1.056
if 'scheduled_dl_wait_value' in json_dict:
scheduled_dl_wait_value = json_dict['scheduled_dl_wait_value']
scheduled_dl_wait_unit = json_dict['scheduled_dl_wait_unit']
scheduled_check_wait_value \
= json_dict['scheduled_check_wait_value']
scheduled_check_wait_unit \
= json_dict['scheduled_check_wait_unit']
else:
scheduled_dl_wait_value = json_dict['scheduled_dl_wait_hours']
scheduled_dl_wait_unit = 'hours'
scheduled_check_wait_value \
= json_dict['scheduled_check_wait_hours']
scheduled_check_wait_unit = 'hours'
scheduled_dl_last_time = json_dict['scheduled_dl_last_time']
scheduled_check_last_time = json_dict['scheduled_check_last_time']
# Renamed in v1.3.120
if 'scheduled_stop_flag' in json_dict:
scheduled_shutdown_flag = json_dict['scheduled_stop_flag']
else:
scheduled_shutdown_flag = json_dict['scheduled_shutdown_flag']
if version >= 2001110: # v2.1.110
scheduled_custom_mode = json_dict['scheduled_custom_mode']
scheduled_custom_wait_value \
= json_dict['scheduled_custom_wait_value']
scheduled_custom_wait_unit \
= json_dict['scheduled_custom_wait_unit']
scheduled_custom_last_time \
= json_dict['scheduled_custom_last_time']
# v2.3.467, changes to the values of some media.Scheduled IVs
if scheduled_check_mode == 'none':
scheduled_check_mode = 'disabled'
elif scheduled_check_mode == 'scheduled':
scheduled_check_mode = 'repeat'
if scheduled_dl_mode == 'none':
scheduled_dl_mode = 'disabled'
elif scheduled_dl_mode == 'scheduled':
scheduled_dl_mode = 'repeat'
if scheduled_custom_mode == 'none':
scheduled_custom_mode = 'disabled'
elif scheduled_custom_mode == 'scheduled':
scheduled_custom_mode = 'repeat'
# Finally create new media.Scheduled objects
if scheduled_check_mode != 'disabled':
new_obj = media.Scheduled(
'default_check',
'sim',
scheduled_check_mode,
)
new_obj.wait_value = scheduled_check_wait_value
new_obj.wait_unit = scheduled_check_wait_unit
new_obj.last_time = scheduled_check_last_time
new_obj.shutdown_flag = scheduled_shutdown_flag
self.scheduled_list.append(new_obj)
if scheduled_dl_mode != 'disabled':
new_obj = media.Scheduled(
'default_download',
'real',
scheduled_dl_mode,
)
new_obj.wait_value = scheduled_dl_wait_value
new_obj.wait_unit = scheduled_dl_wait_unit
new_obj.last_time = scheduled_dl_last_time
new_obj.shutdown_flag = scheduled_shutdown_flag
self.scheduled_list.append(new_obj)
if scheduled_custom_mode != 'disabled':
new_obj = media.Scheduled(
'default_custom',
'custom_real',
scheduled_custom_mode,
)
new_obj.wait_value = scheduled_custom_wait_value
new_obj.wait_unit = scheduled_custom_wait_unit
new_obj.last_time = scheduled_custom_last_time
new_obj.shutdown_flag = scheduled_shutdown_flag
self.scheduled_list.append(new_obj)
def save_config(self):
"""Called by self.start(), .stop_continue(), switch_db(),
.download_manager_finished(), .update_manager_finished(),
.refresh_manager_finished(), .info_manager_finished(),
.tidy_manager_finished(), .on_menu_save_all(),
Saves the Tartube config file. If saving fails, disables all file
loading/saving.
"""
# The config file can be stored at one of two locations, depending on
# whether xdg is available, or not
# v2.0.003 (amended v2.1.034) The user can force Tartube to use the
# config file in the script's directory (rather than the one in the
# location described by xdg) by placing a 'settings.json' file there.
# If that file is created when Tartube is already running, it can be
# an empty file (because Tartube overwrites it). Otherwise, it should
# be a copy of a legitimate config file
config_file_path = self.get_config_path()
# Sanity check
if self.current_manager_obj or self.disable_load_save_flag:
# When called from self.start(), no main window object exists
# yet, and so Tartube will be shut down with this error message
# When called from anything else, throughout this function the
# response is different
if not self.main_win_obj:
self.disable_load_save(
_(
'Failed to save the Tartube config file (failed sanity' \
+ ' check)',
),
)
return
# Prepare values
local = utils.get_local_time()
# Remember the size of the main window, and the positions of sliders in
# the Videos, Progress and Classic Mode tabs, if required
# The minimum saveable size for the main window is half the standard
# size. There is no minimum saveable size for the paneds (but the
# sliders cannot be reduce to nothing anyway)
if self.main_win_obj and self.main_win_save_size_flag:
(width, height) = self.main_win_obj.get_size()
if width >= int(self.main_win_width / 2):
self.main_win_save_width = width
else:
self.main_win_save_width = self.main_win_width
if height >= int(self.main_win_height / 2):
self.main_win_save_height = height
else:
self.main_win_save_height = self.main_win_height
if self.main_win_save_slider_flag:
self.main_win_videos_slider_posn \
= self.main_win_obj.videos_paned.get_position()
self.main_win_progress_slider_posn \
= self.main_win_obj.progress_paned.get_position()
self.main_win_classic_slider_posn \
= self.main_win_obj.classic_paned.get_position()
# If the user wants to recover undownloaded URLs from the Classic Mode
# tab when Tartube restarts, then compile that list of URLs now
if self.classic_pending_flag:
self.classic_pending_list \
= self.main_win_obj.classic_mode_tab_extract_pending_urls()
else:
self.classic_pending_list = []
# Prepare a dictionary of data to save as a JSON file
json_dict = {
# Metadata
'script_name': __main__.__packagename__,
'script_version': __main__.__version__,
'save_date': str(local.strftime('%d %b %Y')),
'save_time': str(local.strftime('%H:%M:%S')),
'file_type': 'config',
# Data
'custom_locale': self.custom_locale,
'thumb_size_custom': self.thumb_size_custom,
'main_win_save_size_flag': self.main_win_save_size_flag,
'main_win_save_slider_flag': self.main_win_save_slider_flag,
'main_win_save_width': self.main_win_save_width,
'main_win_save_height': self.main_win_save_height,
'main_win_videos_slider_posn': self.main_win_videos_slider_posn,
'main_win_progress_slider_posn': \
self.main_win_progress_slider_posn,
'main_win_classic_slider_posn': self.main_win_classic_slider_posn,
'toolbar_hide_flag': self.toolbar_hide_flag,
'toolbar_squeeze_flag': self.toolbar_squeeze_flag,
'show_tooltips_flag': self.show_tooltips_flag,
'show_tooltips_extra_flag': self.show_tooltips_extra_flag,
'show_custom_icons_flag': self.show_custom_icons_flag,
'show_marker_in_index_flag': self.show_marker_in_index_flag,
'show_small_icons_in_index_flag': \
self.show_small_icons_in_index_flag,
'auto_expand_video_index_flag': self.auto_expand_video_index_flag,
'full_expand_video_index_flag': self.full_expand_video_index_flag,
'disable_dl_all_flag': self.disable_dl_all_flag,
'show_custom_dl_button_flag': self.show_custom_dl_button_flag,
'show_free_space_flag': self.show_free_space_flag,
'show_pretty_dates_flag': self.show_pretty_dates_flag,
'catalogue_filter_name_flag': self.catalogue_filter_name_flag,
'catalogue_filter_descrip_flag': \
self.catalogue_filter_descrip_flag,
'catalogue_filter_comment_flag': \
self.catalogue_filter_comment_flag,
'catalogue_draw_frame_flag': self.catalogue_draw_frame_flag,
'catalogue_draw_icons_flag': self.catalogue_draw_icons_flag,
'catalogue_draw_downloaded_flag': \
self.catalogue_draw_downloaded_flag,
'catalogue_draw_undownloaded_flag': \
self.catalogue_draw_undownloaded_flag,
'catalogue_draw_blocked_flag': self.catalogue_draw_blocked_flag,
'catalogue_clickable_container_flag': \
self.catalogue_clickable_container_flag,
'catalogue_show_nickname_flag': self.catalogue_show_nickname_flag,
'drag_video_path_flag': self.drag_video_path_flag,
'drag_video_source_flag': self.drag_video_source_flag,
'drag_video_name_flag': self.drag_video_name_flag,
'drag_thumb_path_flag': self.drag_thumb_path_flag,
'show_status_icon_flag': self.show_status_icon_flag,
'open_in_tray_flag': self.open_in_tray_flag,
'close_to_tray_flag': self.close_to_tray_flag,
'restore_posn_from_tray_flag': self.restore_posn_from_tray_flag,
'progress_list_hide_flag': self.progress_list_hide_flag,
'results_list_reverse_flag': self.results_list_reverse_flag,
'system_error_show_flag': self.system_error_show_flag,
'system_warning_show_flag': self.system_warning_show_flag,
'operation_error_show_flag': self.operation_error_show_flag,
'operation_warning_show_flag': self.operation_warning_show_flag,
'system_msg_show_date_flag': self.system_msg_show_date_flag,
'system_msg_show_container_flag': \
self.system_msg_show_container_flag,
'system_msg_show_video_flag': self.system_msg_show_video_flag,
'system_msg_show_multi_line_flag': \
self.system_msg_show_multi_line_flag,
'system_msg_keep_totals_flag': self.system_msg_keep_totals_flag,
'data_dir': self.data_dir,
'data_dir_alt_list': self.data_dir_alt_list,
'data_dir_use_first_flag': self.data_dir_use_first_flag,
'data_dir_use_list_flag': self.data_dir_use_list_flag,
'data_dir_add_from_list_flag': self.data_dir_add_from_list_flag,
'sound_custom': self.sound_custom,
'export_csv_separator': self.export_csv_separator,
'db_backup_mode': self.db_backup_mode,
'show_classic_tab_on_startup_flag': \
self.show_classic_tab_on_startup_flag,
'classic_custom_dl_flag': self.classic_custom_dl_flag,
'classic_dir_list': self.classic_dir_list,
'classic_dir_previous': self.classic_dir_previous,
'classic_format_selection': self.classic_format_selection,
'classic_format_convert_flag': self.classic_format_convert_flag,
'classic_resolution_selection': self.classic_resolution_selection,
'classic_livestream_flag': self.classic_livestream_flag,
'classic_pending_flag': self.classic_pending_flag,
'classic_pending_list': self.classic_pending_list,
'classic_duplicate_remove_flag': \
self.classic_duplicate_remove_flag,
'ytdl_bin': self.ytdl_bin,
'ytdl_path_default': self.ytdl_path_default,
'ytdl_path': self.ytdl_path,
'ytdl_path_custom_flag': self.ytdl_path_custom_flag,
'ytdl_update_dict': self.ytdl_update_dict,
'ytdl_update_list': self.ytdl_update_list,
'ytdl_update_current': self.ytdl_update_current,
'auto_switch_output_flag': self.auto_switch_output_flag,
'output_size_default': self.output_size_default,
'output_size_apply_flag': self.output_size_apply_flag,
'ytdl_update_once_flag': self.ytdl_update_once_flag,
'ytdl_fork': self.ytdl_fork,
'ytdl_fork_no_dependency_flag': self.ytdl_fork_no_dependency_flag,
'ytdl_output_system_cmd_flag': self.ytdl_output_system_cmd_flag,
'ytdl_output_stdout_flag': self.ytdl_output_stdout_flag,
'ytdl_output_ignore_json_flag': self.ytdl_output_ignore_json_flag,
'ytdl_output_ignore_progress_flag': \
self.ytdl_output_ignore_progress_flag,
'ytdl_output_stderr_flag': self.ytdl_output_stderr_flag,
'ytdl_output_start_empty_flag': self.ytdl_output_start_empty_flag,
'ytdl_output_show_summary_flag': \
self.ytdl_output_show_summary_flag,
'ytdl_write_system_cmd_flag': self.ytdl_write_system_cmd_flag,
'ytdl_write_stdout_flag': self.ytdl_write_stdout_flag,
'ytdl_write_ignore_json_flag': self.ytdl_write_ignore_json_flag,
'ytdl_write_ignore_progress_flag': \
self.ytdl_write_ignore_progress_flag,
'ytdl_write_stderr_flag': self.ytdl_write_stderr_flag,
'ytdl_write_verbose_flag': self.ytdl_write_verbose_flag,
'refresh_output_videos_flag': self.refresh_output_videos_flag,
'refresh_output_verbose_flag': self.refresh_output_verbose_flag,
'refresh_moviepy_timeout': self.refresh_moviepy_timeout,
'disk_space_warn_flag': self.disk_space_warn_flag,
'disk_space_warn_limit': self.disk_space_warn_limit,
'disk_space_stop_flag': self.disk_space_stop_flag,
'disk_space_stop_limit': self.disk_space_stop_limit,
'custom_invidious_mirror': self.custom_invidious_mirror,
'custom_sblock_mirror': self.custom_sblock_mirror,
'dl_proxy_list': self.dl_proxy_list,
'ffmpeg_path': self.ffmpeg_path,
'avconv_path': self.avconv_path,
'ffmpeg_convert_webp_flag': self.ffmpeg_convert_webp_flag,
'livestream_dl_mode': self.livestream_dl_mode,
'livestream_dl_timeout': self.livestream_dl_timeout,
'livestream_replace_flag': self.livestream_replace_flag,
'livestream_stop_is_final_flag': \
self.livestream_stop_is_final_flag,
'livestream_force_check_flag': self.livestream_force_check_flag,
'streamlink_path': self.streamlink_path,
'graph_data_type': self.graph_data_type,
'graph_plot_type': self.graph_plot_type,
'graph_time_period_secs': self.graph_time_period_secs,
'graph_time_unit_secs': self.graph_time_unit_secs,
'graph_ink_colour': self.graph_ink_colour,
'operation_limit_flag': self.operation_limit_flag,
'operation_check_limit': self.operation_check_limit,
'operation_download_limit': self.operation_download_limit,
'show_newbie_dialogue_flag': self.show_newbie_dialogue_flag,
'show_msys2_dialogue_flag': self.show_msys2_dialogue_flag,
'show_delete_video_dialogue_flag': \
self.show_delete_video_dialogue_flag,
'delete_video_files_flag': self.delete_video_files_flag,
'show_delete_container_dialogue_flag': \
self.show_delete_container_dialogue_flag,
'delete_container_files_flag': self.delete_container_files_flag,
'auto_switch_profile_flag': self.auto_switch_profile_flag,
'auto_clone_options_flag': self.auto_clone_options_flag,
'auto_delete_options_flag': self.auto_delete_options_flag,
'simple_options_flag': self.simple_options_flag,
'block_livestreams_flag': self.block_livestreams_flag,
'enable_livestreams_flag': self.enable_livestreams_flag,
'livestream_max_days': self.livestream_max_days,
'livestream_use_colour_flag': self.livestream_use_colour_flag,
'livestream_simple_colour_flag': \
self.livestream_simple_colour_flag,
'livestream_auto_notify_flag': self.livestream_auto_notify_flag,
'livestream_auto_alarm_flag': self.livestream_auto_alarm_flag,
'livestream_auto_open_flag': self.livestream_auto_open_flag,
'livestream_auto_dl_start_flag': \
self.livestream_auto_dl_start_flag,
'livestream_auto_dl_stop_flag': self.livestream_auto_dl_stop_flag,
'scheduled_livestream_flag': self.scheduled_livestream_flag,
'scheduled_livestream_wait_mins': \
self.scheduled_livestream_wait_mins,
'scheduled_livestream_last_time': \
self.scheduled_livestream_last_time,
'scheduled_livestream_extra_flag': \
self.scheduled_livestream_extra_flag,
'autostop_time_flag': self.autostop_time_flag,
'autostop_time_value': self.autostop_time_value,
'autostop_time_unit': self.autostop_time_unit,
'autostop_videos_flag': self.autostop_videos_flag,
'autostop_videos_value': self.autostop_videos_value,
'autostop_size_flag': self.autostop_size_flag,
'autostop_size_value': self.autostop_size_value,
'autostop_size_unit': self.autostop_size_unit,
'operation_auto_update_flag': self.operation_auto_update_flag,
'operation_save_flag': self.operation_save_flag,
'operation_sim_shortcut_flag': self.operation_sim_shortcut_flag,
'operation_auto_restart_flag': self.operation_auto_restart_flag,
'operation_auto_restart_time': self.operation_auto_restart_time,
'operation_auto_restart_max': self.operation_auto_restart_max,
'operation_dialogue_mode': self.operation_dialogue_mode,
'operation_convert_mode': self.operation_convert_mode,
'use_module_moviepy_flag': self.use_module_moviepy_flag,
'dialogue_copy_clipboard_flag': self.dialogue_copy_clipboard_flag,
'dialogue_keep_open_flag': self.dialogue_keep_open_flag,
'dialogue_yt_remind_flag': self.dialogue_yt_remind_flag,
'dialogue_disable_msg_flag': self.dialogue_disable_msg_flag,
'allow_ytdl_archive_flag': self.allow_ytdl_archive_flag,
'allow_ytdl_archive_mode': self.allow_ytdl_archive_mode,
'allow_ytdl_archive_path': self.allow_ytdl_archive_path,
'classic_ytdl_archive_flag': \
self.classic_ytdl_archive_flag,
'apply_json_timeout_flag': self.apply_json_timeout_flag,
'json_timeout_no_comments_time': \
self.json_timeout_no_comments_time,
'json_timeout_with_comments_time': \
self.json_timeout_with_comments_time,
'track_missing_videos_flag': self.track_missing_videos_flag,
'track_missing_time_flag': self.track_missing_time_flag,
'track_missing_time_days': self.track_missing_time_days,
'add_blocked_videos_flag': self.add_blocked_videos_flag,
'store_playlist_id_flag': self.store_playlist_id_flag,
'video_timestamps_extract_json_flag': \
self.video_timestamps_extract_json_flag,
'video_timestamps_extract_descrip_flag': \
self.video_timestamps_extract_descrip_flag,
'video_timestamps_replace_flag': \
self.video_timestamps_replace_flag,
'video_timestamps_re_extract_flag': \
self.video_timestamps_re_extract_flag,
'split_video_name_mode': self.split_video_name_mode,
'split_video_clips_dir_flag': self.split_video_clips_dir_flag,
'split_video_subdir_flag': self.split_video_subdir_flag,
'split_video_add_db_flag': self.split_video_add_db_flag,
'split_video_copy_thumb_flag': self.split_video_copy_thumb_flag,
'split_video_custom_title': self.split_video_custom_title,
'split_video_auto_open_flag': self.split_video_auto_open_flag,
'split_video_auto_delete_flag': self.split_video_auto_delete_flag,
'sblock_fetch_flag': self.sblock_fetch_flag,
'sblock_obfuscate_flag': self.sblock_obfuscate_flag,
'sblock_replace_flag': self.sblock_replace_flag,
'sblock_re_extract_flag': self.sblock_re_extract_flag,
'slice_video_cleanup_flag': self.slice_video_cleanup_flag,
'check_comment_fetch_flag': self.check_comment_fetch_flag,
'dl_comment_fetch_flag': self.dl_comment_fetch_flag,
'comment_store_flag': self.comment_store_flag,
'comment_show_text_time_flag': self.comment_show_text_time_flag,
'comment_show_formatted_flag': self.comment_show_formatted_flag,
'ignore_child_process_exit_flag': \
self.ignore_child_process_exit_flag,
'ignore_http_404_error_flag': self.ignore_http_404_error_flag,
'ignore_data_block_error_flag': self.ignore_data_block_error_flag,
'ignore_merge_warning_flag': self.ignore_merge_warning_flag,
'ignore_missing_format_error_flag': \
self.ignore_missing_format_error_flag,
'ignore_no_annotations_flag': self.ignore_no_annotations_flag,
'ignore_no_subtitles_flag': self.ignore_no_subtitles_flag,
'ignore_page_given_flag': self.ignore_page_given_flag,
'ignore_no_descrip_flag': self.ignore_no_descrip_flag,
'ignore_thumb_404_flag': self.ignore_thumb_404_flag,
'ignore_yt_copyright_flag': self.ignore_yt_copyright_flag,
'ignore_yt_age_restrict_flag': self.ignore_yt_age_restrict_flag,
'ignore_yt_uploader_deleted_flag': \
self.ignore_yt_uploader_deleted_flag,
'ignore_yt_payment_flag': self.ignore_yt_payment_flag,
'ignore_custom_msg_list': self.ignore_custom_msg_list,
'ignore_custom_regex_flag': self.ignore_custom_regex_flag,
'num_worker_default': self.num_worker_default,
'num_worker_apply_flag': self.num_worker_apply_flag,
'num_worker_bypass_flag': self.num_worker_bypass_flag,
'bandwidth_default': self.bandwidth_default,
'bandwidth_apply_flag': self.bandwidth_apply_flag,
'video_res_default': self.video_res_default,
'video_res_apply_flag': self.video_res_apply_flag,
'alt_num_worker': self.alt_num_worker,
'alt_num_worker_apply_flag': self.alt_num_worker_apply_flag,
'alt_bandwidth': self.alt_bandwidth,
'alt_bandwidth_apply_flag': self.alt_bandwidth_apply_flag,
'alt_start_time': self.alt_start_time,
'alt_stop_time': self.alt_stop_time,
'alt_day_string': self.alt_day_string,
'match_method': self.match_method,
'match_first_chars': self.match_first_chars,
'match_ignore_chars': self.match_ignore_chars,
'auto_delete_flag': self.auto_delete_flag,
'auto_delete_days': self.auto_delete_days,
'auto_remove_flag': self.auto_remove_flag,
'auto_remove_days': self.auto_remove_days,
'auto_delete_watched_flag': self.auto_delete_watched_flag,
'auto_delete_asap_flag': self.auto_delete_asap_flag,
'delete_on_shutdown_flag': self.delete_on_shutdown_flag,
'open_temp_on_desktop_flag': self.open_temp_on_desktop_flag,
'complex_index_flag': self.complex_index_flag,
'catalogue_mode': self.catalogue_mode,
'catalogue_mode_type': self.catalogue_mode_type,
'catalogue_page_size': self.catalogue_page_size,
'catalogue_show_filter_flag': self.catalogue_show_filter_flag,
'catalogue_sort_mode': self.catalogue_sort_mode,
'catologue_use_regex_flag': self.catologue_use_regex_flag,
'url_change_confirm_flag': self.url_change_confirm_flag,
'url_change_regex_flag': self.url_change_regex_flag,
'custom_bg_table': self.custom_bg_table,
'ytdlp_filter_options_flag': self.ytdlp_filter_options_flag,
}
# In case a competing instance of Tartube is saving the same config
# file, check for the lockfile and, if it exists, wait a reasonable
# time for it to be released
if not self.debug_ignore_lockfile_flag:
lock_path = config_file_path + '.lock'
if os.path.isfile(lock_path):
check_time = time.time() + self.config_lock_time
while time.time() < check_time and os.path.isfile(lock_path):
time.sleep(0.1)
if os.path.isfile(lock_path):
msg = _(
'Failed to save the Tartube config file (file is' \
+ ' locked)',
) + '\n\n' + _('File load/save has been disabled')
if not self.main_win_obj:
self.disable_load_save(msg)
else:
self.disable_load_save()
self.file_error_dialogue(msg)
return
# Place our own lock on the config file
if not self.debug_ignore_lockfile_flag:
try:
fh = open(lock_path, 'a').close()
except:
msg = _(
'Failed to save the Tartube config file (file already' \
+ ' in use)'
)
if not self.main_win_obj:
self.disable_load_save(msg)
else:
self.disable_load_save()
self.file_error_dialogue(msg)
return
# Try to save the config file
try:
with open(config_file_path, 'w') as outfile:
json.dump(json_dict, outfile, indent=4)
except:
self.remove_file(lock_path)
self.disable_load_save(_('Failed to save the Tartube config file'))
return
# Procedure successful; remove the lock
if not self.debug_ignore_lockfile_flag:
self.remove_file(lock_path)
def get_config_path(self):
"""Can be called by anything (for example, called by self.load_config()
and .save_config() ).
Gets the expected full path to the config file (but does not test
whether it exists, or not).
Return values:
Returns a full path to the config file.
"""
# The config file can be stored at one of two locations, depending on
# whether xdg is available, or not
# v2.0.003 (amended v2.1.034) The user can force Tartube to use the
# config file in the script's directory (rather than the one in the
# location described by xdg) by placing a 'settings.json' file there.
# If that file is created when Tartube is already running, it can be
# an empty file (because Tartube overwrites it). Otherwise, it should
# be a copy of a legitimate config file
if self.config_file_xdg_path is None \
or (
os.path.isfile(self.config_file_path) \
and not __main__.__pkg_strict_install_flag__
):
return self.config_file_path
else:
return self.config_file_xdg_path
def load_db(self, switch_flag=False):
"""Called by self.start() and .switch_db().
Loads the Tartube database file. If loading fails, disables all file
loading/saving.
N.B. Due to serialisation issues in the python 'pickle' module, Tartube
databases from before v1.1.008 cannot be loaded.
Args:
switch_flag (bool): True when called by self.switch_db(), False
otherwise
Returns:
True on success, False on failure
"""
# Sanity check
path = os.path.abspath(os.path.join(self.data_dir, self.db_file_name))
if self.current_manager_obj \
or not os.path.isfile(path) \
or self.db_loading_flag \
or self.disable_load_save_flag:
return False
# This flag is used to detect an interrupted database load due to a
# Python error, which would mean this function never returns
# It is set back to False a few times here, and also by any call to
# self.disable_load_save()
self.db_loading_flag = True
# If a lockfile already exists, then another competing instance of
# Tartube is already using this database file
if not self.debug_ignore_lockfile_flag:
lock_path = path + '.lock'
if os.path.isfile(lock_path):
dialogue_win = mainwin.RemoveLockFileDialogue(
self.main_win_obj,
switch_flag,
)
dialogue_win.run()
remove_flag = dialogue_win.remove_flag
dialogue_win.destroy()
if remove_flag:
# The user thinks it's safe to ignore the stale lockfile
self.remove_stale_lock_file()
elif switch_flag:
# Let the calling code show a dialogue window
self.db_loading_flag = False
return False
else:
# Failed to load database on startup, and therefore
# Tartube will shut down
# (The True argument signals that the user should be
# prompted to artificially remove the lockfile)
self.disable_load_save(
_('Failed to load the Tartube database file'),
True,
)
return False
# Place our own lock on the database file
try:
fh = open(lock_path, 'a').close()
self.db_lock_file_path = lock_path
except:
# (Failure may mean that the directory is unwriteable)
self.disable_load_save(
_('Failed to load the Tartube database file'),
)
return False
# Reset main window tabs now so the user can't manipulate their widgets
# during the load
# (Don't reset the Errors/Warnings tab, as failed attempts to load a
# database generate messages there)
if self.main_win_obj:
self.main_win_obj.video_index_reset_marker()
self.main_win_obj.video_index_reset()
self.main_win_obj.video_catalogue_reset()
self.main_win_obj.progress_list_reset()
self.main_win_obj.results_list_reset()
# If opening Tartube in the system tray, we can't call .show_all()
if self.startup_complete_flag or not self.open_in_tray_flag:
self.main_win_obj.show_all()
# Most main widgets are desensitised, until the database file has been
# loaded
self.main_win_obj.sensitise_widgets_if_database(False)
# Try to load the database file
try:
fh = open(path, 'rb')
load_dict = pickle.load(fh)
fh.close()
except Exception as e:
self.remove_db_lock_file()
self.disable_load_save(
_('Failed to load the Tartube database file') \
+ ': \n\n' + str(e),
)
return False
# Do some basic checks on the loaded data
if not load_dict \
or not 'script_name' in load_dict \
or not 'script_version' in load_dict \
or not 'save_date' in load_dict \
or not 'save_time' in load_dict \
or load_dict['script_name'] != __main__.__packagename__:
self.remove_db_lock_file()
self.file_error_dialogue(
_('The Tartube database file is invalid'),
)
self.db_loading_flag = False
return False
# Convert a version, e.g. 1.234.567, into a simple number, e.g.
# 1234567, that can be compared with other versions
version = self.convert_version(load_dict['script_version'])
# Now check that the database file wasn't written by a more recent
# version of Tartube (which this older version might not be able to
# read)
if version is None \
or version > self.convert_version(__main__.__version__):
self.remove_db_lock_file()
self.disable_load_save(
_('Database file can\'t be read by this version of Tartube'),
)
return False
# Before v1.3.099, self.data_dir and self.downloads_dir were different
# If a /downloads directory exists, then the data directory is using
# the old structure
old_flag = False
if os.path.isdir(self.alt_downloads_dir):
# Use the old location of self.downloads_dir
old_flag = True
self.downloads_dir = self.alt_downloads_dir
# Move any database backup files to their new location
self.move_backup_files()
else:
# Use the new location
self.downloads_dir = self.data_dir
# Set IVs to their new values
if version >= 2003259: # v2.3.258
self.custom_dl_reg_count = load_dict['custom_dl_reg_count']
self.custom_dl_reg_dict = load_dict['custom_dl_reg_dict']
self.general_custom_dl_obj = load_dict['general_custom_dl_obj']
self.classic_custom_dl_obj = load_dict['classic_custom_dl_obj']
self.media_reg_count = load_dict['media_reg_count']
self.media_reg_dict = load_dict['media_reg_dict']
self.media_name_dict = load_dict['media_name_dict']
self.media_top_level_list = load_dict['media_top_level_list']
if version >= 2000048: # v2.0.048
self.media_reg_live_dict = load_dict['media_reg_live_dict']
if version >= 2000052: # v2.0.052
self.media_reg_auto_notify_dict \
= load_dict['media_reg_auto_notify_dict']
if version >= 2000068: # v2.0.068
self.media_reg_auto_alarm_dict \
= load_dict['media_reg_auto_alarm_dict']
if version >= 2000052: # v2.0.052
self.media_reg_auto_open_dict \
= load_dict['media_reg_auto_open_dict']
if version >= 2000054: # v2.0.054
self.media_reg_auto_dl_start_dict \
= load_dict['media_reg_auto_dl_start_dict']
self.media_reg_auto_dl_stop_dict \
= load_dict['media_reg_auto_dl_stop_dict']
self.fixed_all_folder = load_dict['fixed_all_folder']
self.fixed_fav_folder = load_dict['fixed_fav_folder']
self.fixed_new_folder = load_dict['fixed_new_folder']
self.fixed_temp_folder = load_dict['fixed_temp_folder']
self.fixed_misc_folder = load_dict['fixed_misc_folder']
if version >= 1004028: # v1.4.028
self.fixed_bookmark_folder = load_dict['fixed_bookmark_folder']
self.fixed_waiting_folder = load_dict['fixed_waiting_folder']
if version >= 2000042: # v2.0.042
self.fixed_live_folder = load_dict['fixed_live_folder']
if version >= 2001060: # v2.1.060
self.fixed_missing_folder = load_dict['fixed_missing_folder']
if version >= 2003071: # v2.3.071
self.fixed_recent_folder = load_dict['fixed_recent_folder']
if version >= 2000098: # v2.0.098
self.fixed_folder_locale = load_dict['fixed_folder_locale']
if version >= 2003122: # v2.3.122
self.fixed_recent_folder_days \
= load_dict['fixed_recent_folder_days']
if version >= 2002015: # v2.2.015
self.scheduled_list = load_dict['scheduled_list']
if version >= 2004013: # v2.4.013
self.profile_dict = load_dict['profile_dict']
self.last_profile = load_dict['last_profile']
if version >= 2002034: # v2.2.034
self.options_reg_count = load_dict['options_reg_count']
self.options_reg_dict = load_dict['options_reg_dict']
self.general_options_obj = load_dict['general_options_obj']
# Removed v2.2.124
# if version >= 2002051: # v2.1.051
# self.classic_options_list = load_dict['classic_options_list']
if version >= 2001007: # v2.1.007
self.classic_options_obj = load_dict['classic_options_obj']
if version >= 2003487: # v2.3.487
self.classic_dropzone_list = load_dict['classic_dropzone_list']
if version >= 2002149: # v2.2.149
self.ffmpeg_reg_count = load_dict['ffmpeg_reg_count']
self.ffmpeg_reg_dict = load_dict['ffmpeg_reg_dict']
self.ffmpeg_options_obj = load_dict['ffmpeg_options_obj']
self.ffmpeg_simple_options_flag \
= load_dict['ffmpeg_simple_options_flag']
if version >= 2002219: # v2.2.219
self.toolbar_system_hide_flag \
= load_dict['toolbar_system_hide_flag']
if version >= 2003149: # v2.3.149
self.fixed_clips_folder = load_dict['fixed_clips_folder']
# Update the loaded data for this version of Tartube
self.update_db(version)
# If the old directory structure is being used, the user might try to
# manually copy the contents of the /downloads directory into the
# directory above
# To prevent problems when that happens, preemptively rename any media
# data object called 'downloads'
if old_flag and 'downloads' in self.media_name_dict:
dbid = self.media_name_dict['downloads']
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name; the function returns None on failure
new_name = utils.find_available_name(self, 'downloads')
if new_name is not None:
self.rename_container_silently(media_data_obj, new_name)
# If the locale has changed since the loaded database file was last
# saved, update the names of fixed folders
if self.fixed_folder_locale != self.custom_locale:
self.rename_fixed_folders()
self.fixed_folder_locale = self.custom_locale
# Empty any temporary folders
self.delete_temp_folders()
# Auto-delete and auto-remove old downloaded videos
self.auto_delete_old_videos()
self.auto_remove_old_videos()
# Test any channels/playlists/folders which have external directories
# set. If we can't read/write to the external directory, then mark
# the channels/playlists/folders as unavailable
self.check_external()
# If the debugging flag is set, hide all fixed folders
if self.debug_hide_folders_flag:
self.fixed_all_folder.set_hidden_flag(True)
self.fixed_bookmark_folder.set_hidden_flag(True)
self.fixed_fav_folder.set_hidden_flag(True)
self.fixed_live_folder.set_hidden_flag(True)
self.fixed_missing_folder.set_hidden_flag(True)
self.fixed_new_folder.set_hidden_flag(True)
self.fixed_recent_folder.set_hidden_flag(True)
self.fixed_waiting_folder.set_hidden_flag(True)
self.fixed_temp_folder.set_hidden_flag(True)
self.fixed_misc_folder.set_hidden_flag(True)
self.fixed_clips_folder.set_hidden_flag(True)
# Now that a database file has been loaded, most main window widgets
# can be sensitised...
self.main_win_obj.sensitise_widgets_if_database(True)
# ...and saving the database file is now allowed
self.allow_db_save_flag = True
if self.main_win_obj:
# (Dis)activate the main window's menu/toolbar items for showing/
# hiding system folders, as required
if (
not self.main_win_obj.hide_system_menu_item.get_active() \
and self.toolbar_system_hide_flag
):
self.main_win_obj.hide_system_menu_item.set_active(True)
elif (
self.main_win_obj.hide_system_menu_item.get_active() \
and not self.toolbar_system_hide_flag
):
self.main_win_obj.hide_system_menu_item.set_active(False)
# Update other main menu items
self.main_win_obj.update_menu()
# Repopulate the Video Index, showing the new data
self.main_win_obj.video_index_catalogue_reset()
# Automatically mark channels/playlists/folders for download, if
# required
if self.auto_switch_profile_flag and self.last_profile is not None:
self.main_win_obj.switch_profile(self.last_profile)
# Repopulate the Drag and Drop tab
self.main_win_obj.drag_drop_grid_reset()
# Load succeeded
self.db_loading_flag = False
# Permit scheduled downloads again, if they were disabled in an earlier
# unsuccessful call to self.save_db()
self.disable_scheduled_dl_flag = False
return True
def update_db(self, version):
"""Called by self.load_db().
When the Tartube database created by a previous version of Tartube is
loaded, update IVs as required.
Args:
version (int): The version of Tartube that created the database,
already converted to a simple integer by self.convert_version()
"""
# (Other system folders, having been added later, are not required by
# this list)
fixed_folder_list = [
self.fixed_all_folder,
self.fixed_fav_folder,
self.fixed_new_folder,
]
options_obj_list = [self.general_options_obj]
if self.classic_options_obj:
options_obj_list.append(self.classic_options_obj)
for options_obj in self.options_reg_dict.values():
if options_obj != self.general_options_obj \
and (
self.classic_options_obj is None \
or options_obj != self.general_options_obj
):
options_obj_list.append(options_obj)
options_media_list = []
for media_data_obj in self.media_reg_dict.values():
if media_data_obj.options_obj is not None \
and not media_data_obj.options_obj in options_obj_list:
# options_obj_list.append(media_data_obj.options_obj)
options_media_list.append(media_data_obj)
if version < 3012: # v0.3.012
# This version fixed some problems, in which the deletion of media
# data objects was not handled correctly
# Repair the media data registry, as required
for folder_obj in fixed_folder_list:
# Check that videos in 'All Videos', 'New Videos' and
# 'Favourite Videos' still exist in the media data registry
copy_list = folder_obj.child_list.copy()
for child_obj in copy_list:
if isinstance(child_obj, media.Video) \
and not child_obj.parent_obj.dbid in self.media_reg_dict:
folder_obj.del_child(child_obj)
# Video counts in 'All Videos', 'New Videos' and 'Favourite
# Videos' might be wrong
vid_count = new_count = fav_count = dl_count = 0
for child_obj in folder_obj.child_list:
if isinstance(child_obj, media.Video):
vid_count += 1
if child_obj.new_flag:
new_count += 1
if child_obj.fav_flag:
fav_count += 1
if child_obj.dl_flag:
dl_count += 1
folder_obj.reset_counts(
vid_count,
0,
dl_count,
fav_count,
0,
0,
new_count,
0,
)
if version < 4003: # v0.4.002
# This version fixes video format options, which were stored
# incorrectly in options.OptionsManager
key_list = [
'video_format',
'second_video_format',
'third_video_format',
]
for options_obj in options_obj_list:
for key in key_list:
val = options_obj.options_dict[key]
if val != '0':
if val in formats.VIDEO_OPTION_DICT:
# Invert the key-value pair used before v0.4.002
options_obj.options_dict[key] \
= formats.VIDEO_OPTION_DICT[val]
else:
# Completely invalid format description, so
# just reset it
options_obj.options_dict[key] = '0'
# if version < 4004: # v0.4.004
#
# # This version fixes a bug in which moving a channel, playlist or
# # folder to a new location in the media data registry's tree
# # failed to update all the videos that moved with it
# # To be safe, update every video in the registry
# for media_data_obj in self.media_reg_dict.values():
# if isinstance(media_data_obj, media.Video):
# media_data_obj.reset_file_dir()
if version < 4015: # v0.4.015
# This version fixes issues with sorting videos. Channels,
# playlists and folders in a loaded database might not be sorted
# correctly, so just sort them all using the new algorithms
# (Other system folders, having been added later, are not required
# by this list)
container_list = [
self.fixed_all_folder,
self.fixed_new_folder,
self.fixed_fav_folder,
self.fixed_misc_folder,
self.fixed_temp_folder,
]
for dbid in self.media_name_dict.values():
container_list.append(self.media_reg_dict[dbid])
for container_obj in container_list:
container_obj.sort_children(self)
if version < 4022: # v0.4.022
# This version fixes a rare issue in which media.Video.index was
# set to a string, rather than int, value
# Update all existing videos
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video) \
and media_data_obj.index is not None:
media_data_obj.index = int(media_data_obj.index)
if version < 6003: # v0.6.003
# This version fixes an issue in which deleting an individual video
# and then re-adding the same video, downloading it then deleting
# it a second time, messes up the parent container's count IVs
# Nothing for it but to recalculate them all, just in case
for dbid in self.media_name_dict.values():
container_obj = self.media_reg_dict[dbid]
vid_count = new_count = fav_count = dl_count = 0
for child_obj in container_obj.child_list:
if isinstance(child_obj, media.Video):
vid_count += 1
if child_obj.new_flag:
new_count += 1
if child_obj.fav_flag:
fav_count += 1
if child_obj.dl_flag:
dl_count += 1
container_obj.reset_counts(
vid_count,
0,
dl_count,
fav_count,
0,
0,
new_count,
0,
)
if version < 1000013: # v1.0.013
# This version adds nicknames to channels, playlists and folders
for dbid in self.media_name_dict.values():
container_obj = self.media_reg_dict[dbid]
container_obj.nickname = container_obj.name
if version < 1000031: # v1.0.031
# This version adds nicknames to videos. If the database is large,
# warn the user before continuing
if self.media_reg_dict.len() > 1000:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_('Tartube is applying an essential database update') \
+ '\n\n' \
+ _('This might take a few minutes, so please be patient'),
'info',
'ok',
self.main_win_obj,
)
dialogue_win.set_modal(True)
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.nickname = media_data_obj.name
# If the video's JSON data has been saved, we can use that
# to set the nickname
json_path = media_data_obj.get_actual_path_by_ext(
self,
'.info.json',
)
if os.path.isfile(json_path):
json_dict = self.file_manager_obj.load_json(json_path)
if 'title' in json_dict:
media_data_obj.nickname = json_dict['title']
if version < 1001031: # v1.1.031
# This version adds the ability to disable checking/downloading for
# media data objects
for dbid in self.media_name_dict.values():
media_data_obj = self.media_reg_dict[dbid]
media_data_obj.dl_disable_flag = False
if version < 1001032: # v1.1.032
# This version adds video archiving. Archived videos cannot be
# auto-deleted
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.archive_flag = False
if version < 1001037: # v1.1.037
# This version adds alternative destination directories for a
# channel's/playlist's/folder's videos, thumbnails (etc)
for dbid in self.media_name_dict.values():
media_data_obj = self.media_reg_dict[dbid]
media_data_obj.master_dbid = media_data_obj.dbid
media_data_obj.slave_dbid_list = []
if version < 1001045: # v1.1.045
# This version adds a new option to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['use_fixed_folder'] = None
if version < 1001060: # v1.1.060
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['abort_on_error'] = False
options_obj.options_dict['socket_timeout'] = ''
options_obj.options_dict['source_address'] = ''
options_obj.options_dict['force_ipv4'] = False
options_obj.options_dict['force_ipv6'] = False
options_obj.options_dict['geo_verification_proxy'] = ''
options_obj.options_dict['geo_bypass'] = False
options_obj.options_dict['no_geo_bypass'] = False
options_obj.options_dict['geo_bypass_country'] = ''
options_obj.options_dict['geo_bypass_ip_block'] = ''
options_obj.options_dict['match_title_list'] = []
options_obj.options_dict['reject_title_list'] = []
options_obj.options_dict['date'] = ''
options_obj.options_dict['date_before'] = ''
options_obj.options_dict['date_after'] = ''
options_obj.options_dict['min_views'] = 0
options_obj.options_dict['max_views'] = 0
options_obj.options_dict['match_filter'] = ''
options_obj.options_dict['age_limit'] = ''
options_obj.options_dict['include_ads'] = False
options_obj.options_dict['playlist_reverse'] = False
options_obj.options_dict['playlist_random'] = False
options_obj.options_dict['prefer_ffmpeg'] = False
options_obj.options_dict['external_downloader'] = ''
options_obj.options_dict['external_arg_string'] = ''
options_obj.options_dict['force_encoding'] = ''
options_obj.options_dict['no_check_certificate'] = False
options_obj.options_dict['prefer_insecure'] = False
options_obj.options_dict['all_formats'] = False
options_obj.options_dict['prefer_free_formats'] = False
options_obj.options_dict['yt_skip_dash'] = False
options_obj.options_dict['merge_output_format'] = ''
options_obj.options_dict['subs_format'] = ''
options_obj.options_dict['two_factor'] = ''
options_obj.options_dict['net_rc'] = False
options_obj.options_dict['recode_video'] = ''
options_obj.options_dict['pp_args'] = ''
options_obj.options_dict['fixup_policy'] = ''
options_obj.options_dict['prefer_avconv'] = False
options_obj.options_dict['prefer_ffmpeg'] = False
options_obj.options_dict['write_annotations'] = True
options_obj.options_dict['keep_annotations'] = False
options_obj.options_dict['sim_keep_annotations'] = False
# (Also rename one option)
if 'to_audio' in options_obj.options_dict:
options_obj.options_dict['extract_audio'] \
= options_obj.options_dict['to_audio']
options_obj.options_dict.pop('to_audio')
else:
options_obj.options_dict['extract_audio'] = False
# if version < 1003004: # v1.3.004
#
# # The way that directories are stored in media.VideoObj.file_dir
# # has changed. Reset those values for all video objects
# for media_data_obj in self.media_reg_dict.values():
# if isinstance(media_data_obj, media.Video):
#
# media_data_obj.reset_file_dir()
if version < 1003009: # v1.3.009
# In earlier versions,
# refresh.RefreshManager.refresh_from_default_destination() set a
# video's .name, but not its .nickname
# The .refresh_from_default_destination() is already fixed, but we
# need to check every video in the database, and set its
# .nickname if not set
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
if (
media_data_obj.nickname is None \
or media_data_obj.nickname == self.default_video_name
) and media_data_obj.name is not None \
and media_data_obj.name != self.default_video_name:
media_data_obj.nickname = media_data_obj.name
if version < 1003017: # v1.3.017
for options_obj in options_obj_list:
# In earlier versions, the 'prefer_ffmpeg' and
# 'hls_prefer_ffmpeg' download options had been confused
options_obj.options_dict['hls_prefer_ffmpeg'] = False
# In earlier versions, MS Windows users could set the
# 'prefer_ffmpeg' and 'prefer_avconv' options, even though
# the MS Windows installer does not provide AVConv. Reset
# both values
options_obj.options_dict['prefer_ffmpeg'] = False
options_obj.options_dict['prefer_avconv'] = False
# In earlier versions, the download options 'video_format',
# 'second_video_format' and/or 'third_video_format' could
# incorrectly be set to a sound format like 'mp3'. This is
# not the way youtube-dl-gui was supposed to implement its
# formats; remove them, if the user has specified them
if 'third_video_format' in options_obj.options_dict:
if not options_obj.options_dict['third_video_format'] \
in formats.VIDEO_OPTION_DICT:
options_obj.options_dict['third_video_format'] = '0'
if not options_obj.options_dict['second_video_format'] \
in formats.VIDEO_OPTION_DICT:
options_obj.options_dict['second_video_format'] = '0'
if options_obj.options_dict['third_video_format'] \
!= '0':
options_obj.options_dict['second_video_format'] \
= options_obj.options_dict['third_video_format']
options_obj.options_dict['third_video_format'] \
= '0'
if not options_obj.options_dict['video_format'] \
in formats.VIDEO_OPTION_DICT:
options_obj.options_dict['video_format'] = '0'
if options_obj.options_dict['second_video_format'] \
!= '0':
options_obj.options_dict['video_format'] \
= options_obj.options_dict['second_video_format']
options_obj.options_dict['second_video_format'] \
= options_obj.options_dict['third_video_format']
if version <= 1003099: # v1.3.099
# In this version, some container names have become illegal.
# Replace any illegal names with legal ones
for old_name in self.media_name_dict.keys():
if not self.check_container_name_is_legal(old_name):
dbid = self.media_name_dict[old_name]
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
media_data_obj,
utils.find_available_name(self, 'downloads', 2, -1),
)
if version < 1003106: # v1.3.106
# This version adds a new option to options.OptionsManager
for options_obj in options_obj_list:
if options_obj.options_dict['subs_lang'] == '':
options_obj.options_dict['subs_lang_list'] = []
else:
options_obj.options_dict['subs_lang_list'] \
= [ options_obj.options_dict['subs_lang'] ]
if version < 1003110: # v1.3.110
# Before this version, the 'output_template' in
# options.OptionManager was completely broken, containing both
# the filepath to this file, and an '%(uploader)s string that
# broke the structure of Tartube's data directory
# Reset the value if it seems to contain either
for options_obj in options_obj_list:
output_template = options_obj.options_dict['output_template']
if re.search(sys.path[0], output_template) \
or re.search('\%\(uploader\)s', output_template):
options_obj.options_dict['output_template'] \
= '%(title)s.%(ext)s'
if version < 1003111: # v1.3.111
# In this version, formats.py.FILE_OUTPUT_NAME_DICT and
# .FILE_OUTPUT_CONVERT_DICT, so that the custom format's index
# is 0 (was 3)
for options_obj in options_obj_list:
output_format = options_obj.options_dict['output_format']
if output_format == 3:
options_obj.options_dict['output_format'] = 0
elif output_format < 3:
options_obj.options_dict['output_format'] \
= output_format + 1
if version < 1004028: # v1.4.028
# This version adds two new fixed folders. If there are existing
# folders with the same name, they must be renamed
old_list \
= [formats.FOLDER_BOOKMARKS, formats.FOLDER_WAITING_VIDEOS]
for old_name in old_list:
if old_name in self.media_name_dict:
dbid = self.media_name_dict[old_name]
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
media_data_obj,
utils.find_available_name(self, 'downloads', 2, -1),
)
# Now create the new fixed folders
self.fixed_bookmark_folder = self.add_folder(
formats.FOLDER_BOOKMARKS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_waiting_folder = self.add_folder(
formats.FOLDER_WAITING_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
if version < 1004037: # v1.4.037
# Having added new fixed folders, add corresponding new IVs for
# each media.Video object
for dbid in self.media_name_dict.values():
container_obj = self.media_reg_dict[dbid]
for child_obj in container_obj.child_list:
if isinstance(child_obj, media.Video):
child_obj.bookmark_flag = False
child_obj.waiting_flag = False
if version < 1004037: # v1.4.037
# This version adds new IVs to channels, playlists and folders
for dbid in self.media_name_dict.values():
container_obj = self.media_reg_dict[dbid]
container_obj.bookmark_count = 0
container_obj.waiting_count = 0
# # Some of the count IVs were not working 100%, so we'll just
# # recalculate them all
# container_obj.recalculate_counts()
if version < 1004043: # v1.4.043
# This version removes an IV from media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
del media_data_obj.file_dir
if version < 2000012: # v2.0.012
# This version does not add the ytdl-archive.txt file to system
# folders ('Unsorted Videos' and 'Temporary Videos'), but
# continues to add it to channels, playlists and non-system
# folders
# Remove the archive file from system folders, if present
# 'Temporary Videos'
temp_path = os.path.abspath(
os.path.join(
self.fixed_temp_folder.get_default_dir(self),
self.ytdl_archive_name,
),
)
if os.path.isfile(temp_path):
self.remove_file(temp_path)
# 'Unsorted Videos'
unsorted_path = os.path.abspath(
os.path.join(
self.fixed_misc_folder.get_default_dir(self),
self.ytdl_archive_name,
),
)
if os.path.isfile(unsorted_path):
self.remove_file(unsorted_path)
if version < 2000025: # v2.0.025
# This version adds the Classic Mode tab, and new IVs used by it.
# Most of them are only created when needed
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.dummy_flag = False
if version < 2000035: # v2.0.035
# This version adds IVs for livestream detection on compatible
# websites
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.live_mode = 0
elif not isinstance(media_data_obj, media.Folder):
media_data_obj.rss = None
if version < 2000042: # v2.0.042
# This version adds new IVs to channels, playlists and folders
for dbid in self.media_name_dict.values():
container_obj = self.media_reg_dict[dbid]
container_obj.live_count = 0
# This version also creates a new fixed folder. If there are
# existing folders with the same name, they must be renamed
if formats.FOLDER_LIVESTREAMS in self.media_name_dict:
dbid = self.media_name_dict[formats.FOLDER_LIVESTREAMS]
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
media_data_obj,
utils.find_available_name(self, 'downloads', 2, -1),
)
# Now create the new fixed folder
self.fixed_live_folder = self.add_folder(
formats.FOLDER_LIVESTREAMS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
if version < 2000105: # v2.0.105
# This version adds new options to options.OptionsManager, and
# deletes some existing ones
for options_obj in options_obj_list:
options_obj.options_dict['video_format_list'] = []
if options_obj.options_dict['all_formats']:
options_obj.options_dict['video_format_mode'] = 'all'
options_obj.options_dict['all_formats'] = False
else:
options_obj.options_dict['video_format_mode'] = 'single'
if 'second_video_format' in options_obj.options_dict:
options_obj.options_dict.pop('second_video_format')
if 'third_video_format' in options_obj.options_dict:
options_obj.options_dict.pop('third_video_format')
if version < 2001010: # v2.1.010
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.was_live_flag = False
# if version < 2001012: # v2.1.012
#
# # v2.1.005 Addresses problems in which a media.Video might still
# # exist inside the 'New videos' folder (etc), but not anywhere
# # else in the database
# # Still not sure what the cause was, but assuming that it was some
# # ancient issue, long since fixed, force a silent call to the
# # check/fix functions
# self.check_integrity_db(True)
if version < 2001037: # v2.1.037
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.orig_parent = None
if version < 2001041: # v2.1.041
# This version fixes a problem in options.OptionsManager; when
# options were applied to a channel/playlist/folder, the cloned
# dictionary of options contained lists that were not copied
# properly; hence changing one list changed all of them
for options_obj in options_obj_list:
for key in [
'match_title_list', 'reject_title_list',
'video_format_list', 'subs_lang_list',
]:
options_obj.options_dict[key] \
= options_obj.options_dict[key].copy()
if version < 2001060: # v2.1.060
# This version adds a new fixed folder. If there is an existing
# folder with the same name, it must be renamed
if formats.FOLDER_MISSING_VIDEOS in self.media_name_dict:
dbid = self.media_name_dict[formats.FOLDER_MISSING_VIDEOS]
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
media_data_obj,
utils.find_available_name(self, 'downloads', 2, -1),
)
# Now create the new fixed folder
self.fixed_missing_folder = self.add_folder(
formats.FOLDER_MISSING_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
# Having added new the fixed folder, add a corresponding new IV for
# each media.Video object
for dbid in self.media_name_dict.values():
container_obj = self.media_reg_dict[dbid]
container_obj.missing_count = 0
for child_obj in container_obj.child_list:
if isinstance(child_obj, media.Video):
child_obj.missing_flag = False
if version < 2001089: # v2.1.089
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['move_description'] = False
options_obj.options_dict['move_info'] = False
options_obj.options_dict['move_annotations'] = False
options_obj.options_dict['move_thumbnail'] = False
if version < 2002033: # v2.2.033
# This version adds a new option to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['min_sleep_interval'] = 0
options_obj.options_dict['max_sleep_interval'] = 0
if version < 2002034: # v2.2.034
# This version adds a registry for options.OptionsManager objects,
# and gives each object new IVs. Update all IVs
self.options_reg_dict = {}
if self.general_options_obj:
self.options_reg_count += 1
self.general_options_obj.uid = self.options_reg_count
self.general_options_obj.name = 'general'
self.general_options_obj.dbid = None
self.options_reg_dict[self.general_options_obj.uid] \
= self.general_options_obj
if self.classic_options_obj:
self.options_reg_count += 1
self.classic_options_obj.uid = self.options_reg_count
self.classic_options_obj.name = 'classic'
self.classic_options_obj.dbid = None
self.options_reg_dict[self.classic_options_obj.uid] \
= self.classic_options_obj
for media_data_obj in options_media_list:
options_obj = media_data_obj.options_obj
self.options_reg_count +=1
options_obj.uid = self.options_reg_count
options_obj.name = media_data_obj.name
options_obj.dbid = media_data_obj.dbid
self.options_reg_dict[options_obj.uid] = options_obj
if version < 2002049: # v2.2.049
# This version adds an IV to media.Scheduled objects
for scheduled_obj in self.scheduled_list:
scheduled_obj.ignore_limits_flag = False
# if version < 2002051: # v2.2.051
#
# # This version adds a new IV, initially containing any
# # options.OptionsManager objects not attached to a media data
# # object
# self.classic_options_list = []
# if self.classic_options_obj:
# self.classic_options_list.append(self.classic_options_obj)
#
# for options_obj in self.options_reg_dict.values():
#
# if options_obj.dbid is None \
# and options_obj != self.general_options_obj \
# and (
# self.classic_options_obj is None \
# or options_obj != self.classic_options_obj
# ):
# self.classic_options_list.append(options_obj)
if version < 2002101: # v2.2.101
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.live_msg = ''
if version < 2002107: # v2.2.107
# This version adds new IVs to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.live_debut_flag = False
media_data_obj.live_time = 0
# if version < 2002115: # v2.2.115
#
# # The update code for v1.4.037 and v2.1.012 crashes with a python
# # error, when loading a v1.4 database
# # Can fix both problems by doing a silent database integrity check
# self.check_integrity_db(True)
if version < 2002125: # v2.2.125
# Prior to this version, changes to the options.OptionsManager
# name in its edit window were saved to the .options_dict IV by
# mistake. Fix this error
for options_obj in options_obj_list:
if 'name' in options_obj.options_dict:
del options_obj.options_dict['name']
if version < 2002160: # v2.2.160
# This version adds a new IV to media.Channel, media.Playlist and
# media.Folder objects
for media_data_obj in self.media_reg_dict.values():
if not isinstance(media_data_obj, media.Video):
media_data_obj.last_sort_mode = 'default'
if version < 2002175: # v2.2.175
# In recent versions of Tartube, the value of media.Video.live_mode
# could have been set to a dictionary, rather than a valid
# integer. Fix that problem
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video) \
and type(media_data_obj.live_mode) is dict:
media_data_obj.live_mode = 0
if version < 2002188: # v2.2.188
# media.Video IVs that only existed for 'dummy' videos are added to
# all videos in this version
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
if not hasattr(media_data_obj, 'dummy_dir'):
media_data_obj.dummy_dir = None
media_data_obj.dummy_path = None
media_data_obj.dummy_format = None
if version < 2002191: # v2.2.191
# Before this version, drag-and-drop into the main window could
# create a media.Video object whose .source should have been a
# URL, but was instead a URI to a file path, in the form
# 'file://PATH'
# Check every video to remove the invalid sources
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video) \
and media_data_obj.source is not None \
and re.search('^file\:\/\/', media_data_obj.source):
media_data_obj.source = None
if version < 2003006: # v2.3.006
# Fix an error, in which self.reset_db did not reset all IVs that
# are saved in the Tartube database file
# Nothing we can do to reverse time, but we can make sure that
# options.OptionsManager.dbid points to the a valid DBID
for options_obj in self.options_reg_dict.values():
if options_obj.dbid is not None \
and not options_obj.dbid in self.options_reg_dict:
options_obj.dbid = None
if version < 2003026: # v2.3.026
# Fix an error, in which a media data object's .options_obj IV is
# not updated, when the options object is reset (i.e. replaced
# with a new one)
for options_obj in self.options_reg_dict.values():
if options_obj.dbid is not None:
if not options_obj.dbid in self.media_reg_dict:
# Git #228, don't have an explanation for this error
# yet (may have been fixed in v2.3.026-027)
options_obj.reset_dbid()
else:
media_data_obj = self.media_reg_dict[options_obj.dbid]
media_data_obj.set_options_obj(options_obj)
if version < 2003049: # v2.3.049
# This version adds a new option to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['cookies_path'] = ''
if version < 2003071: # v2.3.071
# This version adds a new fixed folder. If there is an existing
# folder with the same name, it must be renamed
if formats.FOLDER_RECENT_VIDEOS in self.media_name_dict:
dbid = self.media_name_dict[formats.FOLDER_RECENT_VIDEOS]
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
media_data_obj,
utils.find_available_name(self, 'downloads', 2, -1),
)
# Now create the new fixed folder
self.fixed_recent_folder = self.add_folder(
formats.FOLDER_RECENT_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
if version < 2003107: # v2.3.107
# This version adds new options to
# ffmpeg_tartube.FFmpegOptionsManager
for options_obj in self.ffmpeg_reg_dict.values():
options_obj.options_dict['gpu_encoding'] = 'libx264'
options_obj.options_dict['hw_accel'] = 'none'
if version < 2003108: # v2.3.108
# Apply fix to youtube-dl update IVs, caused by an issue in
# self.auto_detect_paths(), now fixed (Git #256)
if os.name != 'nt' and __main__.__pkg_strict_install_flag__:
self.ytdl_update_dict = {
'ytdl_update_disabled': [],
}
self.ytdl_update_list = [
'ytdl_update_disabled',
]
self.ytdl_update_current = 'ytdl_update_disabled'
if version < 2003119: # v2.3.119
# This version adds IVs to media.Scheduled objects
for scheduled_obj in self.scheduled_list:
scheduled_obj.scheduled_num_worker = 2
scheduled_obj.scheduled_num_worker_apply_flag = False
scheduled_obj.scheduled_bandwidth = 500
scheduled_obj.scheduled_bandwidth_apply_flag = False
if version < 2003126: # v2.3.126
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['direct_cmd_flag'] = False
options_obj.options_dict['direct_url_flag'] = False
if version < 2003136: # v2.3.136
# This version adds a list of timestamps extracted from the video
# description
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.stamp_list = []
if version < 2003140: # v2.3.140
# This version adds new options to
# ffmpeg_tartube.FFmpegOptionsManager
for options_obj in self.ffmpeg_reg_dict.values():
options_obj.options_dict['split_mode'] = 'video'
options_obj.options_dict['split_list'] = []
if version < 2003146: # v2.3.146
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.split_flag = False
if version < 2003149: # v2.3.149
# This version adds a new fixed folder. If there is an existing
# folder with the same name, it must be renamed
if formats.FOLDER_VIDEO_CLIPS in self.media_name_dict:
dbid = self.media_name_dict[formats.FOLDER_VIDEO_CLIPS]
media_data_obj = self.media_reg_dict[dbid]
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
media_data_obj,
utils.find_available_name(self, 'downloads', 2, -1),
)
# Now create the new fixed folder
self.fixed_clips_folder = self.add_folder(
formats.FOLDER_VIDEO_CLIPS,
None, # No parent folder
False, # Allow downloads
'partial', # Can contain videos and folders
True, # Fixed (folder cannot be removed)
False, # Public
False, # Not temporary
)
if version < 2003205: # v2.3.205
# Git #307. In v2.3.149, media.Folder.restrict_flag was changed to
# media.Folder.restrict_mode, but this function was not updated
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Folder) \
and hasattr(media_data_obj, 'restrict_flag'):
if media_data_obj.restrict_flag:
media_data_obj.restrict_mode = 'full'
else:
media_data_obj.restrict_mode = 'open'
del media_data_obj.restrict_flag
if version < 2003216: # v2.3.216
# This version adds new IVs to media.Channel, media.Playlist and
# media.Folder objects
for media_data_obj in self.media_reg_dict.values():
if not isinstance(media_data_obj, media.Video):
media_data_obj.external_dir = None
if version < 2003224: # v2.3.224
# This version adds new IVs to media.Channel, media.Playlist and
# media.Folder objects
for media_data_obj in self.media_reg_dict.values():
if not isinstance(media_data_obj, media.Video):
media_data_obj.dl_no_db_flag = False
# Other flags in this group are now mutually exclusive;
# check that the older flags aren't both set to True
if media_data_obj.dl_disable_flag \
and media_data_obj.dl_sim_flag:
media_data_obj.dl_sim_flag = False
if version < 2003225: # v2.3.225
# In this version, the behaviour of .dl_disable_flag for
# media.Channel, media.Playlist and media.Folder objects changes:
# it no longer applies to any descendants
# In order to avoid any nasty surprises, update the IV for all
# descendants of any channel/playlist/folder whose
# .dl_disable_flag is True
check_list = self.media_top_level_list.copy()
while check_list:
dbid = check_list.pop()
media_data_obj = self.media_reg_dict[dbid]
if not isinstance(media_data_obj, media.Video) \
and media_data_obj.dl_disable_flag:
for child_obj in media_data_obj.child_list:
if not isinstance(media_data_obj, media.Video):
child_obj.dl_disable_flag = True
# By adding the child to check_list, we ensure that
# its grandchildren are checked as well
check_list.append(child_obj.dbid)
if version < 2003227: # v2.3.227
# This version adds a new option to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['downloader_config'] = False
if version < 2003228: # v2.3.228
# This version adds new options to options.OptionsManager, and
# replaces an existing option
for options_obj in options_obj_list:
options_obj.options_dict['output_format_list'] = []
options_obj.options_dict['output_path_list'] = []
# Removed v2.4.059
# options_obj.options_dict['save_path_list'] = []
if 'save_path' in options_obj.options_dict:
del options_obj.options_dict['save_path']
if version < 2003229: # v2.3.229
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
# (All downloaders)
options_obj.options_dict['ap_mso'] = ''
options_obj.options_dict['ap_username'] = ''
options_obj.options_dict['ap_password'] = ''
# (yt-dlp only)
options_obj.options_dict['extractor_args_list'] = []
options_obj.options_dict['break_on_existing'] = False
options_obj.options_dict['break_on_reject'] = False
options_obj.options_dict['skip_playlist_after_errors'] = 0
options_obj.options_dict['concurrent_fragments'] = 1
options_obj.options_dict['throttled_rate'] = 0
options_obj.options_dict['windows_filenames'] = False
options_obj.options_dict['trim_filenames'] = 0
options_obj.options_dict['force_overwrites'] = False
options_obj.options_dict['write_playlist_metafiles'] = False
options_obj.options_dict['no_clean_info_json'] = False
options_obj.options_dict['write_comments'] = False
options_obj.options_dict['write_link'] = False
options_obj.options_dict['write_url_link'] = False
options_obj.options_dict['write_webloc_link'] = False
options_obj.options_dict['write_desktop_link'] = False
options_obj.options_dict['ignore_no_formats_error'] = False
options_obj.options_dict['force_write_archive'] = False
options_obj.options_dict['sleep_requests'] = 0
options_obj.options_dict['sleep_subtitles'] = 0
options_obj.options_dict['video_multistreams'] = False
options_obj.options_dict['audio_multistreams'] = False
options_obj.options_dict['check_formats'] = False
options_obj.options_dict['allow_unplayable_formats'] = False
options_obj.options_dict['remux_video'] = ''
options_obj.options_dict['embed_metadata'] = False
options_obj.options_dict['convert_thumbnails'] = ''
options_obj.options_dict['split_chapters'] = False
options_obj.options_dict['extractor_retries'] = '3'
options_obj.options_dict['no_allow_dynamic_mpd'] = False
options_obj.options_dict['hls_split_discontinuity'] = False
if version < 2003237: # v2.3.237
# This version adds new IVs to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.vid = None
media_data_obj.slice_list = []
if version < 2003251: # v2.3.251
# This version adds new options to
# ffmpeg_tartube.FFmpegOptionsManager
for options_obj in self.ffmpeg_reg_dict.values():
options_obj.options_dict['slice_mode'] = 'video'
options_obj.options_dict['slice_list'] = []
if version < 2003291: # v2.3.291
# This version adds a new IV to downloads.CustomDLManager objects
for custom_dl_obj in self.custom_dl_reg_dict.values():
if self.classic_custom_dl_obj is not None \
and self.classic_custom_dl_obj == custom_dl_obj:
custom_dl_obj.dl_by_video_flag = True
custom_dl_obj.dl_precede_flag = True
else:
custom_dl_obj.dl_precede_flag = False
if version < 2003295: # v2.3.295
# This version adds a new IV to media.Scheduled objects
for scheduled_obj in self.scheduled_list:
if scheduled_obj.dl_mode == 'custom':
scheduled_obj.dl_mode = 'custom_real'
scheduled_obj.custom_dl_uid \
= self.general_custom_dl_obj.uid
else:
scheduled_obj.custom_dl_uid = None
if version < 2003304: # v2.3.304
# This version fixes an incorrect value for an IV in media.Folder
# objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Folder) \
and media_data_obj.restrict_mode == 'free':
media_data_obj.restrict_mode = 'open'
if version < 2003314: # v2.3.314
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.comment_list = []
if version < 2003316: # v2.3.316
# This version removes an option to options.OptionsManager
for options_obj in options_obj_list:
if 'write_comments' in options_obj.options_dict:
del options_obj.options_dict['write_comments']
if version < 2003375: # v2.3.375
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
# (yt-dlp only)
options_obj.options_dict['no_cookies'] = False
options_obj.options_dict['cookies_from_browser'] = ''
options_obj.options_dict['no_cookies_from_browser'] = True
if version < 2003382: # v2.3.382
# This version adds a new IV to media.Channel and media.Playlist
# objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Channel) \
or isinstance(media_data_obj, media.Playlist):
media_data_obj.playlist_id_dict = {}
if version < 2003409: # v2.3.409
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.subs_list = []
if version < 2003412: # v2.3.412
# This version adds new IVs to downloads.CustomDLManager objects
for custom_dl_obj in self.custom_dl_reg_dict.values():
custom_dl_obj.dl_if_subs_flag = False
custom_dl_obj.ignore_if_no_subs_flag = False
custom_dl_obj.dl_if_subs_list = []
if version < 2003464: # v2.3.464
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.block_flag = False
if version < 2003470: # v2.3.470
# This version modifies IVs in media.Scheduled objects
for scheduled_obj in self.scheduled_list:
scheduled_obj.timetable_list = []
scheduled_obj.timetable_window = 300
if scheduled_obj.start_mode == 'scheduled':
scheduled_obj.start_mode = 'repeat'
if scheduled_obj.start_mode == 'none':
scheduled_obj.start_mode = 'disabled'
if version < 2003487: # v2.3.487
# This version provides options.OptionsManager objects with a
# short description
for options_obj in options_obj_list:
if options_obj == self.general_options_obj:
options_obj.descrip = _(
'General (default) download options',
)
elif self.classic_options_obj \
and options_obj == self.classic_options_obj:
options_obj.descrip = _(
'Download options for the Classic Mode tab',
)
else:
options_obj.descrip = options_obj.name
# This version also adds options.OptionsManager objects to an
# ordered list for use in the Drag and Drop tab
self.classic_dropzone_list = [self.general_options_obj.uid]
if self.classic_options_obj:
self.classic_dropzone_list.append(self.classic_options_obj.uid)
# If the user has already created an options manager called 'mp3',
# use it; otherwise create a new one (as self.start() does)
match_flag = False
for options_obj in options_obj_list:
if options_obj.name == 'mp3':
match_flag = True
self.classic_dropzone_list.append(options_obj.uid)
break
if not match_flag:
mp3_options_obj = self.create_download_options('mp3')
mp3_options_obj.set_mp3_options()
self.classic_dropzone_list.append(mp3_options_obj.uid)
if version < 2003510: # v2.3.510
# This version adds new IVs to downloads.CustomDLManager objects
for custom_dl_obj in self.custom_dl_reg_dict.values():
custom_dl_obj.ignore_stream_flag = False
custom_dl_obj.ignore_old_stream_flag = False
custom_dl_obj.dl_if_stream_flag = False
custom_dl_obj.dl_if_old_stream_flag = False
if version < 2003536: # v2.3.536
# This version adds a new IV to media.Video objects
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
media_data_obj.dummy_dl_flag = False
if version < 2003553: # v2.3.553
# This version adds a new option to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['no_overwrites'] = False
if version < 2003554: # v2.3.554
# Fix for Git #399, remove invalid options.OptionsManager objects
# from the dropzone list
dropzone_list = []
for uid in self.classic_dropzone_list:
if uid in self.options_reg_dict:
dropzone_list.append(uid)
self.classic_dropzone_list = dropzone_list
if version < 2003595: # v2.3.595
# This version adds a new IV to media.Channel and media.Playlist
# objects
for dbid in self.media_name_dict.values():
media_data_obj = self.media_reg_dict[dbid]
if not isinstance(media_data_obj, media.Folder):
media_data_obj.enhanced \
= utils.is_enhanced(media_data_obj.source)
if version < 2003607: # v2.3.607
# Git #405: sticky plaster to repair this broken database
# options.OptionsManager objects have been applied to media data
# objects, but are not in the registry
for media_data_obj in self.media_reg_dict.values():
if media_data_obj.options_obj \
and not media_data_obj.options_obj.uid \
in self.options_reg_dict:
self.options_reg_dict[media_data_obj.options_obj.uid] \
= media_data_obj.options_obj
# (options.OptionsManager.dbid does not match its own
# media data object, so fix that as well)
media_data_obj.options_obj.dbid = media_data_obj.dbid
# Because of that error, options.OptionsManager have not been
# updated by this function
test_options_obj = options.OptionsManager(-1, 'test')
for real_options_obj in self.options_reg_dict.values():
if not hasattr(real_options_obj, 'descrip'):
real_options_obj.descrip = real_options_obj.name
for option in test_options_obj.options_dict:
if not option in real_options_obj.options_dict:
if isinstance(
test_options_obj.options_dict[option],
list,
) or isinstance(
test_options_obj.options_dict[option],
dict,
):
real_options_obj.options_dict[option] \
= test_options_obj.options_dict[option].copy()
else:
real_options_obj.options_dict[option] \
= test_options_obj.options_dict[option]
if version < 2004056: # v2.4.056
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['live_from_start'] = False
options_obj.options_dict['wait_for_video_min'] = 0
if version < 2004059: # v2.4.059
# This version removes an obsolete download option from
# options.OptionsManager
for options_obj in options_obj_list:
if 'save_path_list' in options_obj.options_dict:
del options_obj.options_dict['save_path_list']
if version < 2004074: # v2.4.074
# Perform repairs on self.classic_dropzone_list, which was
# corrupted when any of the options.OptionsManager objects were
# reset
mod_list = []
for uid in self.classic_dropzone_list:
if uid in self.options_reg_dict:
mod_list.append(uid)
self.classic_dropzone_list = mod_list
if version < 2004084: # v2.4.084
# This version adds new options to options.OptionsManager
for options_obj in options_obj_list:
options_obj.options_dict['playlist_items'] = ''
# --- Do this last, or the call to .check_integrity_db() fails -------
# --------------------------------------------------------------------
if version < 2002115: # v2.2.115
# The update code for v1.4.037 and v2.1.012 crashes with a python
# error, when loading a v1.4 database
# Can fix both problems by doing a silent database integrity check
self.check_integrity_db(True)
elif self.check_broken_objs():
# v2.3.356: Git #356 reports failure of self.update_db() to update
# the database correctly, in a way that's hard to analyse
# Solve all future issues of this kind by routinely checking
# that media data objects have the IVs they're supposed to have
self.fix_broken_objs()
def save_db(self):
"""Called by self.start(), .stop_continue(), .switch_db(),
.fix_integrity_db(), .download_manager_finished(),
.update_manager_finished(), .refresh_manager_finished(),
.info_manager_finished(), .tidy_manager_finished(),
.move_container_to_top_continue(), .move_container_continue(),
.rename_container(), .on_menu_save_all() and .on_menu_save_db().
Saves the Tartube database file.
Since v2.3.555 (Git #400), file loading/saving is no longer disabled if
saving the database fails (so the user can correct a problem like a
full hard drive, before trying again).
Returns:
True on success, False on failure
"""
# Sanity check
if self.current_manager_obj \
or self.disable_load_save_flag \
or not self.allow_db_save_flag:
return False
# Prepare values
local = utils.get_local_time()
path = os.path.abspath(os.path.join(self.data_dir, self.db_file_name))
bu_path = os.path.abspath(
os.path.join(
self.backup_dir,
__main__.__packagename__ + '_BU.db',
),
)
temp_bu_path = os.path.abspath(
os.path.join(
self.backup_dir,
__main__.__packagename__ + '_TEMP_BU.db',
),
)
# Prepare a dictionary of data to save, using Python pickle
save_dict = {
# Metadata
'script_name': __main__.__packagename__,
'script_version': __main__.__version__,
'save_date': str(local.strftime('%d %b %Y')),
'save_time': str(local.strftime('%H:%M:%S')),
# Custom downloads
'custom_dl_reg_count': self.custom_dl_reg_count,
'custom_dl_reg_dict': self.custom_dl_reg_dict,
'general_custom_dl_obj': self.general_custom_dl_obj,
'classic_custom_dl_obj': self.classic_custom_dl_obj,
# Media data objects
'media_reg_count': self.media_reg_count,
'media_reg_dict': self.media_reg_dict,
'media_name_dict': self.media_name_dict,
'media_top_level_list': self.media_top_level_list,
'media_reg_live_dict': self.media_reg_live_dict,
'media_reg_auto_notify_dict': self.media_reg_auto_notify_dict,
'media_reg_auto_alarm_dict': self.media_reg_auto_alarm_dict,
'media_reg_auto_open_dict': self.media_reg_auto_open_dict,
'media_reg_auto_dl_start_dict': self.media_reg_auto_dl_start_dict,
'media_reg_auto_dl_stop_dict': self.media_reg_auto_dl_stop_dict,
'fixed_all_folder': self.fixed_all_folder,
'fixed_bookmark_folder': self.fixed_bookmark_folder,
'fixed_fav_folder': self.fixed_fav_folder,
'fixed_live_folder': self.fixed_live_folder,
'fixed_missing_folder': self.fixed_missing_folder,
'fixed_new_folder': self.fixed_new_folder,
'fixed_recent_folder': self.fixed_recent_folder,
'fixed_waiting_folder': self.fixed_waiting_folder,
'fixed_temp_folder': self.fixed_temp_folder,
'fixed_misc_folder': self.fixed_misc_folder,
'fixed_clips_folder': self.fixed_clips_folder,
'fixed_folder_locale': self.fixed_folder_locale,
'fixed_recent_folder_days': self.fixed_recent_folder_days,
# Scheduled downloads
'scheduled_list': self.scheduled_list,
# Profiles
'profile_dict': self.profile_dict,
'last_profile': self.last_profile,
# Download options
'options_reg_count' : self.options_reg_count,
'options_reg_dict' : self.options_reg_dict,
'general_options_obj' : self.general_options_obj,
'classic_options_obj' : self.classic_options_obj,
'classic_dropzone_list': self.classic_dropzone_list,
# FFmpeg options
'ffmpeg_reg_count' : self.ffmpeg_reg_count,
'ffmpeg_reg_dict' : self.ffmpeg_reg_dict,
'ffmpeg_options_obj' : self.ffmpeg_options_obj,
'ffmpeg_simple_options_flag' : self.ffmpeg_simple_options_flag,
# Main window toolba
'toolbar_system_hide_flag' : self.toolbar_system_hide_flag,
}
# Back up any existing file
if os.path.isfile(path):
try:
shutil.copyfile(path, temp_bu_path)
except:
# self.disable_load_save()
self.disable_scheduled_dl()
self.file_error_dialogue(
_('Failed to save the Tartube database file') \
+ '\n\n' \
+ _(
'(Could not make a backup copy of the existing file)'
) \
+ '\n\n' \
+ _('File load/save has been disabled'),
)
return False
# If there is no lock already in place (for example, because this is a
# new database file), then create a lockfile
if not self.debug_ignore_lockfile_flag:
if self.db_lock_file_path is None:
lock_path = path + '.lock'
if os.path.isfile(lock_path):
self.system_error(
101,
'Database file \'' + path + '\' already exists,' \
+ ' and is locked',
)
return False
else:
# Place our own lock on the database file
try:
fh = open(lock_path, 'a').close()
self.db_lock_file_path = lock_path
except:
# self.disable_load_save(
# _(
# 'Failed to save the Tartube database file (file' \
# + ' already in use)',
# ),
# )
self.disable_scheduled_dl()
self.file_error_dialogue(
_(
'Failed to save the Tartube database file (file' \
+ ' already in use)',
),
)
return False
# Try to save the database file
try:
fh = open(path, 'wb')
pickle.dump(save_dict, fh)
fh.close()
except:
# self.disable_load_save()
self.disable_scheduled_dl()
if os.path.isfile(temp_bu_path):
self.file_error_dialogue(
_('Failed to save the Tartube database file') \
+ '\n\n' \
+ _('A backup of the previous file can be found at:') \
+ '\n\n ' + temp_bu_path + '\n\n' \
+ _('File load/save has been disabled'),
)
else:
self.file_error_dialogue(
_('Failed to save the Tartube database file') \
+ '\n\n' + _('File load/save has been disabled'),
)
return False
# In the event that there was no database file to backup, then the
# following code isn't necessary
if os.path.isfile(temp_bu_path):
# Make the backup file permanent, or not, depending on settings
if self.db_backup_mode == 'default':
self.remove_file(temp_bu_path)
elif self.db_backup_mode == 'single':
utils.rename_file(self, temp_bu_path, bu_path)
elif self.db_backup_mode == 'daily':
daily_bu_path = os.path.abspath(
os.path.join(
self.backup_dir,
__main__.__packagename__ + '_BU_' \
+ str(local.strftime('%Y_%m_%d')) + '.db',
),
)
# Only make a new backup file once per day
if not os.path.isfile(daily_bu_path):
utils.rename_file(self, temp_bu_path, daily_bu_path)
else:
self.remove_file(temp_bu_path)
elif self.db_backup_mode == 'always':
always_bu_path = os.path.abspath(
os.path.join(
self.backup_dir,
__main__.__packagename__ + '_BU_' \
+ str(local.strftime('%Y_%m_%d_%H_%M_%S')) + '.db',
),
)
utils.rename_file(self, temp_bu_path, always_bu_path)
# Saving a database file, in order to create a new file, is much like
# loading one: main window widgets can now be sensitised
self.main_win_obj.sensitise_widgets_if_database(True)
# Save succeeded. Permit scheduled downloads again, if they were
# disabled in an earlier unsuccessful call to this function
self.disable_scheduled_dl_flag = False
return True
def switch_db(self, data_list):
"""Called by config.SystemPrefWin.try_switch_db().
When the user selects a new location for a data directory, first save
our existing database.
Then load the database at the new location, if exists, or create a new
database there, if not.
Args:
data_list (list): A list containing two items: the full file path
to the location of the new data directory, and the system
preferences window (config.SystemPrefWin) that the user has
open
Returns:
True on success, False on failure
"""
# Extract values from the argument list
path = data_list.pop(0)
pref_win_obj = data_list.pop(0)
# Sanity check
if self.current_manager_obj or self.disable_load_save_flag:
return False
# If the old path is the same as the new one, we don't need to do
# anything
if path == self.data_dir:
return False
# Save the existing database, and release its lockfile
if not self.save_db():
return False
else:
self.remove_db_lock_file()
# If the new database file is not loaded for any reason, then we can
# restore the values of various IVs. (As far as the user is
# concerned, nothing has happened)
self.backup_data_variables_before_switch()
# Update IVs for the new location of the data directory
self.data_dir = path
self.update_data_dirs()
if self.data_dir_add_from_list_flag \
and not self.data_dir in self.data_dir_alt_list:
self.data_dir_alt_list.append(self.data_dir)
# Before v1.3.099, self.data_dir and self.downloads_dir were different
# If a /downloads directory exists, then the data directory is using
# the old structure
if os.path.isdir(self.alt_downloads_dir):
# Use the old location of self.downloads_dir
self.downloads_dir = self.alt_downloads_dir
else:
# Use the new location
self.downloads_dir = self.data_dir
# If the data directory, and/or any of its sub-directories don't exist,
# then try to create them
if not os.path.isdir(self.data_dir) \
and not self.make_directory(self.data_dir):
return False
if not os.path.isdir(self.backup_dir) \
and not self.make_directory(self.backup_dir):
return False
# If the database file itself doesn't exist, create it. Otherwise, try
# to load it
db_path = os.path.abspath(
os.path.join(self.data_dir, self.db_file_name),
)
if not os.path.isfile(db_path):
# Reset main window widgets
# (Don't reset the Erors/Warnings tab, as failed attempts to load a
# database generate messages there)
self.main_win_obj.video_index_reset()
self.main_win_obj.video_catalogue_reset()
self.main_win_obj.progress_list_reset()
self.main_win_obj.results_list_reset()
# Reset database IVs
self.reset_db()
# Create a new database file
self.save_db()
# Save the config file, to preserve the new location of the data
# directory
self.save_config()
# Repopulate the Video Index, showing the new data
self.main_win_obj.video_index_populate()
# If the system preferences window is open, reset it to show the
# new data directory
if pref_win_obj and pref_win_obj.is_visible():
pref_win_obj.reset_window()
pref_win_obj.select_switch_db_tab()
self.dialogue_manager_obj.show_msg_dialogue(
_('Database file created'),
'info',
'ok',
pref_win_obj,
)
else:
# (Parent window is the main window)
self.dialogue_manager_obj.show_msg_dialogue(
_('Database file created'),
'info',
'ok',
)
# Update temporary directories for both the old and new
# database locations
self.update_temporary_dirs_after_switch()
# Reset the backup values for various IVs that we no longer need
self.clear_data_variables_after_switch()
return True
elif not self.load_db(True):
# Failed to load the database file. Restore the values for various
# IVs
self.restore_data_variables_after_switch()
return False
else:
# Successfully loaded the database file. Update temporary
# directories for both the old and new database locations
self.update_temporary_dirs_after_switch()
# Reset the backup values for various IVs that we no longer need
self.clear_data_variables_after_switch()
# Save the config file, to preserve the new location of the data
# directory
self.save_config()
return True
def backup_data_variables_before_switch(self):
"""Called by self.switch_db().
Before loading the replacement database, make a backup copy of several
IVs. If the load fails, then those values can be restored (in a call to
self.restore_data_variables_after_switch() ), and the user can continue
using the previous database, as before.
"""
self.backup_data_dir = self.data_dir
self.backup_downloads_dir = self.downloads_dir
self.backup_alt_downloads_dir = self.alt_downloads_dir
self.backup_backup_dir = self.backup_dir
self.backup_temp_dir = self.temp_dir
self.backup_temp_dl_dir = self.temp_dl_dir
self.backup_temp_test_dir = self.temp_test_dir
self.backup_data_dir_alt_list = self.data_dir_alt_list.copy()
def clear_data_variables_after_switch(self):
"""Called by self.switch_db().
After succesfully loading a replacement database, reset the backup
copies of several IVs we made, in case the load failed.
"""
self.backup_data_dir = None
self.backup_downloads_dir = None
self.backup_alt_downloads_dir = None
self.backup_backup_dir = None
self.backup_temp_dir = None
self.backup_temp_dl_dir = None
self.backup_temp_test_dir = None
self.backup_data_dir_alt_list = None
def restore_data_variables_after_switch(self):
"""Called by self.switch_db().
After failing to load a replacement database, restore the original
values of several IVs, so the user can continue using the previous
database, as before.
"""
self.data_dir = self.backup_data_dir
self.downloads_dir = self.backup_downloads_dir
self.alt_downloads_dir = self.backup_alt_downloads_dir
self.dir = self.backup_dir
self.temp_dir = self.backup_temp_dir
self.temp_dl_dir = self.backup_temp_dl_dir
self.temp_test_dir = self.backup_temp_test_dir
self.data_dir_alt_list = self.backup_data_dir_alt_list.copy()
def update_temporary_dirs_after_switch(self):
"""Called by self.switch_db().
After succesfully loading a replacement database, remove temporary
directories, both for the old and new database files.
"""
# For the old database, delete Tartube's temporary folder from the
# filesystem
if os.path.isdir(self.backup_temp_dir):
self.remove_directory(self.backup_temp_dir)
# For the new database, the temporary data directory should be emptied,
# if it already exists)
if os.path.isdir(self.temp_dir) \
and not self.remove_directory(self.temp_dir):
if not self.make_directory(self.temp_dir):
return False
else:
self.remove_directory(self.temp_dir)
if not os.path.isdir(self.temp_dir):
self.make_directory(self.temp_dir)
if not os.path.isdir(self.temp_dl_dir):
self.make_directory(self.temp_dl_dir)
def choose_alt_db(self):
"""Called by self.start() (only), shortly after loading (or creating)
the config file.
Multiple instances of Tartube can share the same config file, but not
the same database file.
If the database file specified by the config file we've just loaded
is locked (meaning it's in use by another instance), we might be
able to use one of the alternative data directories specified by the
user.
"""
db_file_path = os.path.abspath(
os.path.join(self.data_dir, self.db_file_name),
)
lock_file_path = db_file_path + '.lock'
if os.path.exists(self.data_dir) \
and os.path.isfile(db_file_path) \
and os.path.isfile(lock_file_path) \
and not self.debug_ignore_lockfile_flag:
msg = 'Tartube database \'{0}\' can\'t be loaded - another' \
+ ' instance of Tartube may be using it. If not, you can' \
+ ' fix this problem by deleting the lockfile \'{1}\''
self.system_warning(
102,
msg.format(self.data_dir, lock_file_path),
)
for alt_data_dir in self.data_dir_alt_list:
if alt_data_dir == self.data_dir:
# Already tried this one
continue
alt_db_file_path = os.path.abspath(
os.path.join(alt_data_dir, self.db_file_name),
)
alt_lock_file_path = alt_db_file_path + '.lock'
if os.path.exists(alt_data_dir) \
and os.path.isfile(alt_db_file_path) \
and (
not os.path.isfile(alt_lock_file_path) \
or self.debug_ignore_lockfile_flag
):
# Try loading this database instead
self.data_dir = alt_data_dir
self.update_data_dirs()
return
else:
msg = 'Tartube database \'{0}\' can\'t be loaded' \
+ ' - another instance of Tartube may be using it.' \
+ ' If not, you can fix this problem by deleting' \
+ ' the lockfile \'{1}\''
self.system_warning(
103,
msg.format(alt_data_dir, alt_lock_file_path),
)
def forget_db(self, data_list):
"""Called by config.SystemPrefWin.on_data_dir_forget_button_clicked().
When the user selects a data directory to be forgotten (i.e. removed
from self.data_dir_alt_list), perform that action.
Args:
data_list (list): A list containing two items: the full file path
to the location of the selected data directory, and the system
preferences window (config.SystemPrefWin) that the user has
open
Returns:
True on success, False on failure
"""
# Extract values from the argument list
path = data_list.pop(0)
pref_win_obj = data_list.pop(0)
# Sanity check. It shouldn't be possible to select the current data
# directory, but we'll check anyway
if self.current_manager_obj \
or self.disable_load_save_flag \
or path == self.data_dir:
return False
# Update the IV
if path in self.data_dir_alt_list:
self.data_dir_alt_list.remove(path)
# If the system preferences window is open, reset it to show the new
# contents of the IV
if pref_win_obj and pref_win_obj.is_visible():
pref_win_obj.reset_window()
pref_win_obj.select_switch_db_tab()
# Procedure complete
return True
def forget_all_db(self, pref_win_obj=None):
"""Called by
config.SystemPrefWin.on_data_dir_forget_all_button_clicked().
When the user wants to forget all data directories except the current
one, perform that action.
Args:
pref_win_obj (config.SystemPrefWin): The system preferences window
that the user has open, if any
Returns:
True on success, False on failure
"""
# Sanity check
if self.current_manager_obj or self.disable_load_save_flag:
return False
# Update the IV
self.data_dir_alt_list = [ self.data_dir ]
# If the system preferences window is open, reset it to show the new
# contents of the IV
if pref_win_obj and pref_win_obj.is_visible():
pref_win_obj.reset_window()
pref_win_obj.select_switch_db_tab()
# Procedure complete
return True
def reset_db(self):
"""Called by self.switch_db().
Resets media registry IVs, so that a new Tartube database file can be
created.
"""
# Reset IVs to their default states
self.custom_dl_reg_count = 0
self.custom_dl_reg_dict = {}
self.general_custom_dl_obj = self.create_custom_dl_manager('general')
self.classic_custom_dl_obj = self.create_custom_dl_manager('classic')
self.media_reg_count = 0
self.media_reg_dict = {}
self.media_name_dict = {}
self.media_top_level_list = []
self.media_reg_live_dict = {}
self.media_reg_auto_notify_dict = {}
self.media_reg_auto_alarm_dict = {}
self.media_reg_auto_open_dict = {}
self.media_reg_auto_dl_start_dict = {}
self.media_reg_auto_dl_stop_dict = {}
self.fixed_all_folder = None
self.fixed_bookmark_folder = None
self.fixed_fav_folder = None
self.fixed_live_folder = None
self.fixed_missing_folder = None
self.fixed_new_folder = None
self.fixed_recent_folder = None
self.fixed_waiting_folder = None
self.fixed_temp_folder = None
self.fixed_misc_folder = None
self.fixed_clips_folder = None
self.fixed_folder_locale = self.custom_locale
self.scheduled_list = []
self.options_reg_count = 0
self.options_reg_dict = {}
self.general_options_obj = self.create_download_options('general')
self.classic_options_obj = self.create_download_options('classic')
self.ffmpeg_reg_count = 0
self.ffmpeg_reg_dict = {}
self.ffmpeg_options_obj = self.create_ffmpeg_options('default')
self.ffmpeg_simple_options_flag = True
self.toolbar_system_hide_flag = False
# Create new fixed folders (which sets the values of
# self.fixed_all_folder, etc)
self.create_fixed_folders()
def check_integrity_db(self, no_prompt_flag=False, parent_win_obj=None):
"""Called by config.SystemPrefWin.on_data_check_button_clicked() and
also by self.update_db().
In case the Tartube database contains inconsistencies of any kind (for
example, an earlier failure in mainwin.DeleteContainerDialogue left
some channel/playlist/folder objects in a half-deleted state), check
the database for inconsistencies.
If inconsistencies are found, prompt the user for permission to
repair them. The repair process only updates Tartube data; it doesn't
modify any other files or folders in the user's filesystem.
Args:
no_prompt_flag (bool): If True, don't prompt the user to repair
errors; just go ahead and repair them
parent_win_obj (config.SystemPrefWin): Specified when called from
the preferences window, in which case that window is presented
(moved to the forefront) when the confirmation window is
closed, instead of the main window
"""
# Basic checks
if self.disable_load_save_flag:
self.system_error(
104,
'Cannot check/fix database after load/save has been disabled',
)
return
if self.current_manager_obj:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Tartube\'s database can\'t be checked while an operation is' \
+ ' in progress',
),
'error',
'ok',
)
return
# Check the database, looking for media.Video, media.Channel,
# media.Playlist and media.Folder objects (or their .dbids) that,
# due to some problem or other, appear in one IV but not another
# If inconsistencies are found, add them to this dictionary, and
# then apply the fixes once we've finished checking everything
error_reg_dict = {}
# (Two additional dictionaries for recording any errors in the
# .master_dbid and .slave_dbid_list IVs, which are fixed separately)
error_master_dict = {}
error_slave_dict = {}
# (The number of channel/playlist/folders whose flag counts are wrong)
flag_error_count = 0
# (Two further dictionaries for recording inconsistencies in
# options.OptionsManager objects)
error_options_dict = {}
error_options_media_dict = {}
error_options_media_reverse_dict = {}
# (The number of media data objects which appear to have missing IVs,
# because of some failure or other in self.update_db() )
broken_obj_count = 0
# Check that entries in self.media_name_dict appear in
# self.media_reg_dict
for dbid in self.media_name_dict.values():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
# Check that entries in self.media_top_level_list appear in
# self.media_reg_dict
for dbid in self.media_top_level_list:
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
# Check that entries in self.media_reg_live_dict (and its subsets)
# appear in self.media_reg_dict
for dbid in self.media_reg_live_dict.keys():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
for dbid in self.media_reg_auto_notify_dict.keys():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
for dbid in self.media_reg_auto_alarm_dict.keys():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
for dbid in self.media_reg_auto_open_dict.keys():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
for dbid in self.media_reg_auto_dl_start_dict.keys():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
for dbid in self.media_reg_auto_dl_stop_dict.keys():
if not dbid in self.media_reg_dict:
error_reg_dict[dbid] = None
# self.media_reg_dict contains, in theory, every video/channel/
# playlist/folder object
# Walk the tree whose top level is self.media_top_level_list to get a
# list of all containers
toplevel_container_obj_list = []
for dbid in self.media_top_level_list:
if not dbid in error_reg_dict:
toplevel_container_obj_list.append(self.media_reg_dict[dbid])
full_container_obj_list = []
for container_obj in toplevel_container_obj_list:
full_container_obj_list.extend(
container_obj.compile_all_containers( [] ),
)
# v2.1.029 In some older databases, a fixed folder called 'downloads_2'
# was created, containing a small number of videos. I'm still not
# sure under which circumstances that folder was created; in any
# case, such a folder should be deleted
for container_obj in full_container_obj_list:
if isinstance(container_obj, media.Folder) \
and container_obj.fixed_flag \
and not self.check_fixed_folder(container_obj):
error_reg_dict[container_obj.dbid] = container_obj
# Make a copy of self.media_reg_dict...
check_reg_dict = self.media_reg_dict.copy()
# ...then compare the list of containers (and their child videos),
# looking for any which don't appear in self.media_reg_dict
for container_obj in full_container_obj_list:
if container_obj.dbid in self.media_reg_dict:
# Container OK
if container_obj.dbid in check_reg_dict:
del check_reg_dict[container_obj.dbid]
for child_obj in container_obj.child_list:
if isinstance(child_obj, media.Video):
if not child_obj.dbid in self.media_reg_dict \
or child_obj != self.media_reg_dict[child_obj.dbid]:
# Child video not OK
error_reg_dict[child_obj.dbid] = child_obj
else:
# Child video OK
if child_obj.dbid in check_reg_dict:
del check_reg_dict[child_obj.dbid]
else:
# Container not OK
error_reg_dict[container_obj.dbid] = container_obj
# Anything left in check_reg_dict shouldn't be there
for dbid in check_reg_dict:
error_reg_dict[dbid] = check_reg_dict[dbid]
# Check every media data object's parent
for media_data_obj in self.media_reg_dict.values():
if media_data_obj.parent_obj is not None \
and (
not media_data_obj.parent_obj.dbid in self.media_reg_dict \
or isinstance(media_data_obj.parent_obj, media.Video) \
or not media_data_obj in media_data_obj.parent_obj.child_list
):
error_reg_dict[media_data_obj.dbid] = media_data_obj
# Check every media data object's children (but don't check private
# folders, as their children are also stored in a different
# channel/playlist/folder)
for media_data_obj in self.media_reg_dict.values():
if not isinstance(media_data_obj, media.Video) \
and (
not isinstance(media_data_obj, media.Folder) \
or not media_data_obj.priv_flag
):
for child_obj in media_data_obj.child_list:
if child_obj.parent_obj is None \
or child_obj.parent_obj != media_data_obj:
error_reg_dict[child_obj.dbid] = child_obj
# Check alternative download destinations for each channel/playlist/
# folder
for media_data_obj in self.media_reg_dict.values():
if not isinstance(media_data_obj, media.Video):
# (Check the destination still exists in the media data
# registry)
if media_data_obj.master_dbid is not None \
and not media_data_obj.master_dbid in self.media_reg_dict:
error_master_dict[media_data_obj.dbid] = media_data_obj
for slave_dbid in media_data_obj.slave_dbid_list:
if not slave_dbid in self.media_reg_dict:
error_slave_dict[media_data_obj.dbid] = media_data_obj
# Initial check complete. Any media data object in error_reg_dict
# must have its children added too (we can't remove an object from
# the database, and not its children)
for dbid in list(error_reg_dict.keys()):
media_data_obj = error_reg_dict[dbid]
if media_data_obj is not None \
and not isinstance(media_data_obj, media.Video):
descendant_list = media_data_obj.compile_all_containers( [] )
for descendant_obj in descendant_list:
error_reg_dict[descendant_obj.dbid] = descendant_obj
for child_obj in descendant_obj.child_list:
if isinstance(child_obj, media.Video):
error_reg_dict[child_obj.dbid] = child_obj
# Check that container counts are correct
for dbid in self.media_name_dict.values():
# (Don't bother checking broken media data objects, since all
# counts for all channels/playlists/folders will be recalculated
# anyway)
if dbid not in error_reg_dict:
media_data_obj = self.media_reg_dict[dbid]
if media_data_obj.test_counts():
flag_error_count += 1
# Failsafe check: it shouldn't be possible for system folders to be
# in error_reg_dict, but check anyway, and discard them if found
mod_error_reg_dict = {}
for dbid in list(error_reg_dict.keys()):
media_data_obj = error_reg_dict[dbid]
# (The corresponding media.Video, media.Channel, media.Playlist or
# media.Folder may be known, or not)
if media_data_obj is None \
or not isinstance(media_data_obj, media.Folder) \
or not media_data_obj.fixed_flag \
or not self.check_fixed_folder(media_data_obj):
mod_error_reg_dict[dbid] = media_data_obj
# Final check on options.OptionsManager objects
for options_obj in self.options_reg_dict.values():
if options_obj.dbid is not None:
if not options_obj.dbid in self.media_reg_dict:
error_options_dict[options_obj.uid] = options_obj
else:
media_data_obj = self.media_reg_dict[options_obj.dbid]
if media_data_obj.options_obj is None \
or media_data_obj.options_obj != options_obj:
error_options_dict[options_obj.uid] = options_obj
error_options_media_dict[media_data_obj.dbid] \
= media_data_obj
for media_data_obj in self.media_reg_dict.values():
if media_data_obj.options_obj \
and not media_data_obj.options_obj.uid in self.options_reg_dict:
error_options_media_reverse_dict[media_data_obj.dbid] \
= media_data_obj.options_obj
# .update_db() updates objects from earlier releases of Tartube with
# new IVs. Git #356 reports a database that has become broken due to
# missing IVs that .update_db() was not able to add
# Check one example of each type of object, looking for missing IVs
broken_obj_count = self.check_broken_objs()
# Check complete
if not mod_error_reg_dict \
and not error_master_dict \
and not error_slave_dict \
and not flag_error_count \
and not error_options_dict \
and not error_options_media_dict \
and not error_options_media_reverse_dict \
and not broken_obj_count:
if not no_prompt_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_('Database check complete, no inconsistencies found'),
'info',
'ok',
parent_win_obj,
)
return
elif no_prompt_flag:
# Don't prompt the user to repair errors; just go ahead and repair
# them
self.fix_integrity_db(
[
mod_error_reg_dict,
error_master_dict,
error_slave_dict,
error_options_dict,
error_options_media_dict,
error_options_media_reverse_dict,
broken_obj_count,
no_prompt_flag,
parent_win_obj,
],
)
else:
total = len(error_reg_dict) + len(error_master_dict) \
+ len(error_slave_dict) + flag_error_count \
+ len(error_options_dict) + len(error_options_media_dict) \
+ len(error_options_media_reverse_dict)
# Prompt the user before deleting stuff
self.dialogue_manager_obj.show_msg_dialogue(
_('Database check complete, problems found:') \
+ ' ' + str(total) + '\n\n' \
+ _(
'Do you want to repair these problems? (The database will be' \
+ ' fixed, but no files will be deleted)',
),
'question',
'yes-no',
parent_win_obj,
# Arguments passed directly to .fix_integrity_db()
{
'yes': 'fix_integrity_db',
'data': [
mod_error_reg_dict,
error_master_dict,
error_slave_dict,
error_options_dict,
error_options_media_dict,
error_options_media_reverse_dict,
broken_obj_count,
no_prompt_flag,
parent_win_obj,
],
},
)
def fix_integrity_db(self, data_list):
"""Called by self.check_integrity_db() (only).
After the user has given permission to fix inconsistencies in the
Tartube database, perform the repairs, and save files.
The repair process only updates Tartube IVs; it doesn't delete any
files or folders in the filesystem.
Args:
data_list (list): A list containing several dictionaries and some
flags. List in the form:
error_reg_dict[dbid] = media_data_obj
error_reg_dict[dbid] = None
(A general dictionary of errors to fix. All references to
the media data objects in this dictionary are removed from
all IVs)
error_master_dict[dbid] = media_data_obj
(A dictionary of errors in a channel/playlist/folder's
.master_dbid IV, which are fixed separately)
error_slave_dict[dbid] = media_data_obj
(A dictionary of errors in a channel/playlist/folder's
.slave_dbid_list IV, which are fixed separately)
error_options_dict[uid] = options_obj
error_options_media_dict[dbid] = media_data_obj
error_options_media_reverse_dict[dbid] = options_obj
(Dictionaries of inconsistencies between media data objects
and options.OptionsManager objects. These
errors are fixed separately)
broken_obj_count (list): The number of media data objects which
appear to have missing IVs, because of some failure or
other in self.update_db()
no_prompt_flag (bool): If True, don't show a dialogue window at
the end of the procedure
parent_win_obj (config.SystemPrefWin): Specified when called
from the preferences window, in which case that window is
presented (moved to the forefront) when the confirmation
window is closed, instead of the main window
"""
# Extract the arguments
error_reg_dict = data_list.pop(0)
error_master_dict = data_list.pop(0)
error_slave_dict = data_list.pop(0)
error_options_dict = data_list.pop(0)
error_options_media_dict = data_list.pop(0)
error_options_media_reverse_dict = data_list.pop(0)
broken_obj_count = data_list.pop(0)
no_prompt_flag = data_list.pop(0)
parent_win_obj = data_list.pop(0)
# Update mainapp.TartubeApp IVs
for dbid in error_reg_dict.keys():
# (The corresponding media.Video, media.Channel, media.Playlist or
# media.Folder may be known, or not)
error_obj = error_reg_dict[dbid]
if dbid in self.media_reg_dict:
del self.media_reg_dict[dbid]
if error_obj is not None \
and error_obj.name in self.media_name_dict:
del self.media_name_dict[error_obj.name]
if dbid in self.media_top_level_list:
self.media_top_level_list.remove(dbid)
if dbid in self.media_reg_live_dict:
del self.media_reg_live_dict[dbid]
if dbid in self.media_reg_auto_notify_dict:
del self.media_reg_auto_notify_dict[dbid]
if dbid in self.media_reg_auto_alarm_dict:
del self.media_reg_auto_alarm_dict[dbid]
if dbid in self.media_reg_auto_open_dict:
del self.media_reg_auto_open_dict[dbid]
if dbid in self.media_reg_auto_dl_start_dict:
del self.media_reg_auto_dl_start_dict[dbid]
if dbid in self.media_reg_auto_dl_stop_dict:
del self.media_reg_auto_dl_stop_dict[dbid]
# Check each media data object's child list, and remove anything that
# should be removed
for media_data_obj in self.media_reg_dict.values():
if not isinstance(media_data_obj, media.Video):
remove_list = []
for child_obj in media_data_obj.child_list:
if child_obj.dbid in error_reg_dict:
remove_list.append(child_obj)
for child_obj in remove_list:
media_data_obj.child_list.remove(child_obj)
# Recalculate counts for all channels/playlists/folders
for dbid in self.media_name_dict.values():
media_data_obj = self.media_reg_dict[dbid]
media_data_obj.recalculate_counts()
# Deal with alternative download destinations
for media_data_obj in error_master_dict.values():
if not media_data_obj.master_dbid in self.media_reg_dict:
media_data_obj.set_master_dbid(self, media_data_obj.dbid)
for media_data_obj in error_slave_dict.values():
del_list = []
for slave_dbid in media_data_obj.slave_dbid_list:
if not slave_dbid in self.media_reg_dict:
del_list.append(slave_dbid)
for slave_dbid in del_list:
media_data_obj.del_slave_dbid(slave_dbid)
# Deal with inconsistencies between the media data registry and
# options.OptionsManager objects
for options_obj in error_options_dict.values():
options_obj.reset_dbid()
for media_data_obj in error_options_media_dict.values():
media_data_obj.reset_options_obj()
if error_options_media_reverse_dict:
# (In the case of options.OptionsManager objects missing from their
# registry, they may not have been updated in self.update_db().
# Check for that as well)
test_options_obj = options.OptionsManager(-1, 'test')
for dbid in error_options_media_reverse_dict.keys():
media_data_obj = self.media_reg_dict[dbid]
options_obj = error_options_media_reverse_dict[dbid]
self.options_reg_dict[options_obj.uid] = options_obj
media_data_obj.options_obj.dbid = media_data_obj.dbid
if not hasattr(options_obj, 'descrip'):
options_obj.descrip = options_obj.name
for option in test_options_obj.options_dict:
if not option in options_obj.options_dict:
if isinstance(
test_options_obj.options_dict[option],
list,
) or isinstance(
test_options_obj.options_dict[option],
dict,
):
options_obj.options_dict[option] \
= test_options_obj.options_dict[option].copy()
else:
options_obj.options_dict[option] \
= test_options_obj.options_dict[option]
# Deal with broken objects due to failures in .update_db()
if broken_obj_count:
self.fix_broken_objs()
# Save the database file (unless load/save has been disabled very
# recently)
if not self.disable_load_save_flag:
self.save_db()
# Redraw the Video Index and Video Catalogue
self.main_win_obj.video_index_catalogue_reset()
# Show confirmation (if allowed)
if not no_prompt_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_('Database inconsistencies repaired'),
'info',
'ok',
parent_win_obj,
)
def check_broken_objs(self):
"""Called by self.update_db() and .check_integrity_db().
Git #356 reports failure of self.update_db() to update the database
correctly, in a way that's hard to analyse.
Check that all media data objects have the IVs they're supposed to
have, and return the number of problems found.
Returns:
A number in the range 0-4
"""
count = 0
# Get a specimen of each type of media data object
video_obj, channel_obj, playlist_obj, folder_obj \
= self.compile_specimen_obj_list()
# Check IVs in a specimen media.Video objec
if video_obj:
iv_dict = video_obj.compile_updated_ivs()
for key in iv_dict.keys():
if not (hasattr(video_obj, key)):
count += 1
break
# Check IVs in a specimen media.Channel objec
if channel_obj:
iv_dict = channel_obj.compile_updated_ivs()
for key in iv_dict.keys():
if not (hasattr(channel_obj, key)):
count += 1
break
# Check IVs in a specimen media.Playlist objec
if playlist_obj:
iv_dict = playlist_obj.compile_updated_ivs()
for key in iv_dict.keys():
if not (hasattr(playlist_obj, key)):
count += 1
break
# Check IVs in a specimen media.Folder objec
if folder_obj:
iv_dict = folder_obj.compile_updated_ivs()
for key in iv_dict.keys():
if not (hasattr(folder_obj, key)):
count += 1
break
# Return the number of problems found
return count
def fix_broken_objs(self):
"""Called by self.update_db() and .check_integrity_db(), immediately
after a call to self.check_broken_objs().
Some or all media data objects have missing IVs, as a result of a
failure somewhere in self.update_db(). Update all media data objects to
add any missing IVs with default values.
"""
for media_data_obj in self.media_reg_dict.values():
update_dict = media_data_obj.compile_updated_ivs()
for key in update_dict.keys():
if not hasattr(media_data_obj, key):
setattr(media_data_obj, key, update_dict[key])
def compile_specimen_obj_list(self):
"""Called by self.check_broken_objs().
Returns a list of specimen media data objects: one media.Video,
media.Channel, media.Playlist and media.Folder object.
Returns:
A list of objects, in the order (video, channel, playlist, folder).
If those objects haven't been created yet, the list contains
one or more None values instead
"""
# Find a specimen media.Video object
video_obj = None
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
video_obj = media_data_obj
break
# Find specimen media.Channel, media.Playlist and media.Folder objects
count = 0
channel_obj = None
playlist_obj = None
folder_obj = None
for media_data_obj in self.media_name_dict.values():
if isinstance(media_data_obj, media.Channel) and not channel_obj:
channel_obj = media_data_obj
count += 1
if count >= 3:
break
elif isinstance(media_data_obj, media.Playlist) \
and not playlist_obj:
playlist_obj = media_data_obj
count += 1
if count >= 3:
break
elif isinstance(media_data_obj, media.Folder) \
and not folder_obj:
folder_obj = media_data_obj
count += 1
if count >= 3:
break
return video_obj, channel_obj, playlist_obj, folder_obj
def update_data_dirs(self):
"""Called by self.load_config() or by any other function.
After changing the value of self.data_dir (perhaps via a call to
self.set_data_dir() ), any code can call this function to update the
variables that are derived from it.
"""
self.downloads_dir = self.data_dir
self.alt_downloads_dir = os.path.abspath(
os.path.join(self.data_dir, 'downloads'),
)
self.backup_dir = os.path.abspath(
os.path.join(self.data_dir, '.backups'),
)
self.temp_dir = os.path.abspath(os.path.join(self.data_dir, '.temp'))
self.temp_dl_dir = os.path.abspath(
os.path.join(self.data_dir, '.temp', 'downloads'),
)
self.temp_test_dir = os.path.abspath(
os.path.join(self.data_dir, '.temp', 'ytdl-test'),
)
def setup_paths(self):
"""Called by self.start().
Sets the default values of various IVs handling the path of the
installed youtube-dl.
On MS Windows, these are fixed. On other operating systems, we try to
auto-detect youtube-dl's location, if possible.
"""
# Set youtube-dl path IVs
if os.name == 'nt':
if 'PROGRAMFILES(X86)' in os.environ:
# 64-bit MS Windows
recommended = 'ytdl_update_win_64'
alt_recommended = 'ytdl_update_win_64_no_dependencies'
python_path = '..\\..\\..\\mingw64\\bin\python3.exe'
pip_path = '..\\..\\..\\mingw64\\bin\pip3-script.py'
else:
# 32-bit MS Windows
recommended = 'ytdl_update_win_32'
alt_recommended = 'ytdl_update_win_32_no_dependencies'
python_path = '..\\..\\..\\mingw32\\bin\python3.exe'
pip_path = '..\\..\\..\\mingw32\\bin\pip3-script.py'
self.ytdl_bin = 'youtube-dl'
self.ytdl_path_default = 'youtube-dl'
self.ytdl_path = 'youtube-dl'
self.ytdl_update_dict = {
recommended: [
python_path,
pip_path,
'install',
'--upgrade',
'youtube-dl',
],
alt_recommended: [
python_path,
pip_path,
'install',
'--upgrade',
'--no-dependencies',
'youtube-dl',
],
'ytdl_update_pip3': [
'pip3', 'install', '--upgrade', 'youtube-dl',
],
'ytdl_update_pip3_no_dependencies': [
'pip3', 'install', '--upgrade', '--no-dependencies',
'youtube-dl',
],
'ytdl_update_pip': [
'pip', 'install', '--upgrade', 'youtube-dl',
],
'ytdl_update_pip_no_dependencies': [
'pip', 'install', '--upgrade', '--no-dependencies',
'youtube-dl',
],
'ytdl_update_default_path': [
self.ytdl_path_default, '-U',
],
'ytdl_update_local_path': [
self.ytdl_bin, '-U',
],
'ytdl_update_custom_path': [
'python3', self.ytdl_path, '-U',
],
}
self.ytdl_update_list = [
recommended,
alt_recommended,
'ytdl_update_pip3',
'ytdl_update_pip3_no_dependencies',
'ytdl_update_pip',
'ytdl_update_pip_no_dependencies',
'ytdl_update_default_path',
'ytdl_update_local_path',
'ytdl_update_custom_path',
]
self.ytdl_update_current = recommended
else:
self.ytdl_bin = 'youtube-dl'
self.ytdl_path_default = os.path.abspath(
os.path.join(os.sep, 'usr', 'bin', self.ytdl_bin),
)
# Set up the shell commands for updating youtube-dl
if __main__.__pkg_strict_install_flag__:
self.ytdl_update_dict = {
'ytdl_update_disabled': [],
}
self.ytdl_update_list = [
'ytdl_update_disabled',
]
self.ytdl_update_current = 'ytdl_update_disabled'
else:
self.ytdl_update_dict = {
'ytdl_update_pip3_recommend': [
'pip3', 'install', '--upgrade', '--user', 'youtube-dl',
],
'ytdl_update_pip3_omit_user': [
'pip3', 'install', '--upgrade', 'youtube-dl',
],
'ytdl_update_pip3_no_dependencies': [
'pip3', 'install', '--upgrade', '--no-dependencies',
'youtube-dl',
],
'ytdl_update_pip': [
'pip', 'install', '--upgrade', '--user', 'youtube-dl',
],
'ytdl_update_pip_omit_user': [
'pip', 'install', '--upgrade', 'youtube-dl',
],
'ytdl_update_pip_no_dependencies': [
'pip', 'install', '--upgrade', '--no-dependencies',
'youtube-dl',
],
'ytdl_update_default_path': [
self.ytdl_path_default, '-U',
],
'ytdl_update_local_path': [
self.ytdl_bin, '-U',
],
'ytdl_update_custom_path': [
'python3', self.ytdl_path, '-U',
],
'ytdl_update_pypi_path': [
self.ytdl_path_pypi, '-U',
],
}
self.ytdl_update_list = [
'ytdl_update_pip3_recommend',
'ytdl_update_pip3_omit_user',
'ytdl_update_pip3_no_dependencies',
'ytdl_update_pip',
'ytdl_update_pip_omit_user',
'ytdl_update_pip_no_dependencies',
'ytdl_update_default_path',
'ytdl_update_local_path',
'ytdl_update_custom_path',
'ytdl_update_pypi_path',
]
# Auto-detect the location of youtube-dl, and set the perferred
# shell command
self.auto_detect_paths()
def auto_detect_paths(self):
"""Can be called by anything (initially called by self.setup_paths() ).
Tries to auto-detect the location of youtube-dl, and updates IVs
accordingly.
"""
# (Doesn't apply to MS Windows, for which paths are fixed)
if os.name != 'nt':
pypi_path = re.sub(
'^\~', os.path.expanduser('~'),
self.ytdl_path_pypi,
)
if os.path.isfile(pypi_path) \
or __main__.__pkg_install_flag__:
self.ytdl_path = self.ytdl_path_pypi
elif os.path.isfile(self.ytdl_path_default):
self.ytdl_path = self.ytdl_path_default
else:
self.ytdl_path = self.ytdl_bin
if not __main__.__pkg_strict_install_flag__:
if self.ytdl_path == self.ytdl_path_pypi:
self.ytdl_update_current = 'ytdl_update_pip3_recommend'
elif self.ytdl_path == self.ytdl_path_default:
self.ytdl_update_current = 'ytdl_update_default_path'
else:
self.ytdl_update_current = 'ytdl_update_local_path'
def auto_delete_old_videos(self, update_flag=False):
"""Called by self.load_db and .download_manager_finished().
Auto-delete any old downloaded videos (if auto-deletion is enabled).
The video is removed from the database, and all files associated with
the video are deleted from the filesystem.
Args:
update_flag (bool): If True, the Video Catalogue is updated;
otherwise it is not
"""
if not self.auto_delete_flag:
return
# Calculate the system time before which any downloaded videos can be
# deleted
time_limit = int(time.time()) - (self.auto_delete_days * 24 * 60 * 60)
# Import a list of media data objects (as self.media_reg_dict will be
# modified during this procedure)
media_list = list(self.media_reg_dict.values())
# Auto-delete any videos as required
for media_data_obj in media_list:
if isinstance(media_data_obj, media.Video) \
and media_data_obj.dl_flag \
and not media_data_obj.archive_flag \
and media_data_obj.receive_time < time_limit \
and (
not self.auto_delete_watched_flag \
or not media_data_obj.new_flag
):
# Ddelete this video
self.delete_video(
media_data_obj,
True,
not update_flag,
not update_flag,
)
def auto_remove_old_videos(self, update_flag=False):
"""Called by self.load_db and .download_manager_finished().
Auto-remove any old downloaded videos (if auto-removal is enabled).
The video is removed from the database, but no files associated with
the video are deleted from the filesystem.
Args:
update_flag (bool): If True, the Video Catalogue is updated;
otherwise it is not
"""
if not self.auto_remove_flag:
return
# Calculate the system time before which any downloaded videos can be
# removed
time_limit = int(time.time()) - (self.auto_remove_days * 24 * 60 * 60)
# Import a list of media data objects (as self.media_reg_dict will be
# modified during this procedure)
media_list = list(self.media_reg_dict.values())
# Auto-remove any videos as required
for media_data_obj in media_list:
if isinstance(media_data_obj, media.Video) \
and media_data_obj.dl_flag \
and not media_data_obj.archive_flag \
and media_data_obj.receive_time < time_limit \
and (
not self.auto_delete_watched_flag \
or not media_data_obj.new_flag
):
# Remove this video
self.delete_video(
media_data_obj,
False,
not update_flag,
not update_flag,
)
def check_external(self):
"""Called by self.load_db() (only).
Test any channels/playlists/folders which have external directories
set. If we can't read/write to the external directory, then mark them
as unavailable.
An unavailable channel/playlist/folder can't be checked/downloaded/
custom downloaded.
"""
# After loading a new database, clear any existing unavailable
# containers
self.media_unavailable_dict = {}
# (If multiple channels/playlists/folders use a shared external
# directory, we don't need to test the directory more than once)
check_dict = {}
# Now check every container which has an external directory set
for dbid in self.media_name_dict.values():
media_data_obj = self.media_reg_dict[dbid]
if media_data_obj.external_dir is not None:
if media_data_obj.external_dir in check_dict \
or not self.check_external_dir(media_data_obj.external_dir):
self.media_unavailable_dict[media_data_obj.name] = dbid
check_dict[media_data_obj.external_dir] = None
def check_external_dir(self, dir_path):
"""Called by self.check_external (only).
The specified directory is the external directory for a channel,
playlist or folder.
If it contains a semaphore file, check that it can be read and written.
If it doesn't contain a semaphore file, try to create one there.
Args:
dir_path (str): Full path to the external directory to check
Return values:
True if the external directory is readable, False if it should be
marked as unavailable
"""
# Make the semaphore file, if it doesn't already exist
# (This function returns the file path on success, or if the file
# alread exists. It returns None if the directory doesn't exist or if
# the semaphore file can't be created)
file_path = self.make_semaphore_file(dir_path)
if file_path is None:
return False
# Check reading the file
try:
fh = open(file_path, 'r')
fh.read()
fh.close()
except:
return False
# Try writing the file
try:
fh = open(file_path, 'w')
fh.write('')
fh.close()
except:
return False
# All good
return True
def convert_version(self, version):
"""Can be called by anything, but mostly called by self.load_config()
and load_db().
Converts a Tartube version number, a string in the form '1.234.567',
into a simple integer in the form 1234567.
The calling function can then compare the version number for this
installation of Tartube with the version number that created the file.
Args:
version (str): A string in the form '1.234.567'
Returns:
The simple integer, or None if the 'version' argument was invalid
"""
num_list = version.split('.')
if len(num_list) != 3:
return None
else:
return (int(num_list[0]) * 1000000) + (int(num_list[1]) * 1000) \
+ int(num_list[2])
def find_sound_effects(self):
"""Called by self.start().
Set the directory in which sound files are stored.
When installed via PyPI, the files are moved to ../tartube/sounds.
When installed via a Debian/RPM package, the files are moved to
/usr/share/tartube/sounds.
Compiles a list of paths to sound effects found in the /sounds
directory, and updates the IVs.
"""
sound_dir_list = []
sound_dir_list.append(
os.path.abspath(
os.path.join(self.script_parent_dir, 'sounds'),
),
)
sound_dir_list.append(
os.path.abspath(
os.path.join(
os.path.dirname(os.path.realpath(__file__)),
'sounds',
),
),
)
sound_dir_list.append(
os.path.join(
'/', 'usr', 'share', __main__.__packagename__, 'sounds',
)
)
for sound_dir_path in sound_dir_list:
if os.path.isdir(sound_dir_path):
self.sound_dir = sound_dir_path
# Get a list of available sound files, and sort alphabetically
for (dirpath, dir_list, file_list) in os.walk(self.sound_dir):
for filename in file_list:
if filename != 'COPYING':
self.sound_list.append(filename)
self.sound_list.sort()
return
def create_fixed_folders(self):
"""Called by self.start() and .reset_db().
Creates the fixed (system) media.Folder objects that can't be
destroyed by the user.
"""
self.fixed_all_folder = self.add_folder(
formats.FOLDER_ALL_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_bookmark_folder = self.add_folder(
formats.FOLDER_BOOKMARKS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_fav_folder = self.add_folder(
formats.FOLDER_FAVOURITE_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_fav_folder.set_fav_flag(True)
self.fixed_live_folder = self.add_folder(
formats.FOLDER_LIVESTREAMS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_missing_folder = self.add_folder(
formats.FOLDER_MISSING_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_new_folder = self.add_folder(
formats.FOLDER_NEW_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_recent_folder = self.add_folder(
formats.FOLDER_RECENT_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_waiting_folder = self.add_folder(
formats.FOLDER_WAITING_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
True, # Private
False, # Not temporary
)
self.fixed_temp_folder = self.add_folder(
formats.FOLDER_TEMPORARY_VIDEOS,
None, # No parent folder
False, # Allow downloads
'open', # Can contain any media data object
True, # Fixed (folder cannot be removed)
False, # Public
True, # Temporary
)
self.fixed_misc_folder = self.add_folder(
formats.FOLDER_UNSORTED_VIDEOS,
None, # No parent folder
False, # Allow downloads
'full', # Can only contain videos
True, # Fixed (folder cannot be removed)
False, # Public
False, # Not temporary
)
self.fixed_clips_folder = self.add_folder(
formats.FOLDER_VIDEO_CLIPS,
None, # No parent folder
False, # Allow downloads
'partial', # Can contain videos and folders
True, # Fixed (folder cannot be removed)
False, # Public
False, # Not temporary
)
def rename_fixed_folders(self):
"""Called by self.load_db() (only).
If the locale used when saving the database file has changed then,
having loaded the file, we can rename all the fixed folders to match
the new locale.
This function must only be called for that reason; fixed folders cannot
otherwise be renamed.
"""
self.rename_fixed_folder(
self.fixed_all_folder,
formats.FOLDER_ALL_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_bookmark_folder,
formats.FOLDER_BOOKMARKS,
)
self.rename_fixed_folder(
self.fixed_fav_folder,
formats.FOLDER_FAVOURITE_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_live_folder,
formats.FOLDER_LIVESTREAMS,
)
self.rename_fixed_folder(
self.fixed_missing_folder,
formats.FOLDER_MISSING_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_new_folder,
formats.FOLDER_NEW_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_recent_folder,
formats.FOLDER_RECENT_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_waiting_folder,
formats.FOLDER_WAITING_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_temp_folder,
formats.FOLDER_TEMPORARY_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_misc_folder,
formats.FOLDER_UNSORTED_VIDEOS,
)
self.rename_fixed_folder(
self.fixed_clips_folder,
formats.FOLDER_VIDEO_CLIPS,
)
def rename_fixed_folder(self, media_data_obj, new_name):
"""Called by self.rename_fixed_folders() (only).
Renames the specified media.Folder object to match the new locale.
Args:
media_data_obj (media.Folder): The folder to rename
new_name (str): The folder's new name, matching (for example)
formats.FOLDER_ALL_VIDEOS, formats.FOLDER_BOOKMARKS, etc
"""
# If there is (by chance) a folder with the same name, it must be
# renamed
if new_name in self.media_name_dict:
other_dbid = self.media_name_dict[new_name]
other_obj = self.media_reg_dict[other_dbid]
# Sanity check: don't rename another fixed folder
if isinstance(other_obj, media.Folder) and other_obj.fixed_flag:
return
# Generate a new name. The -1 argument means to keep going
# indefinitely, until an available name is found
self.rename_container_silently(
other_obj,
utils.find_available_name(self, other_obj.name, 2, -1),
)
# Now rename the specified folder
self.rename_container_silently(media_data_obj, new_name)
def check_fixed_folder(self, media_data_obj):
"""Called by self.check_fixed_folder() or .delete_container().
Checks whether a specified media data object is one of the standard
fixed folders (i.e., a system folder that can't be deleted).
Args:
media_data_obj (media.Folder): The media data object to test
Returns:
True if it's one of the recognised fixed folders, False otherwise
"""
if media_data_obj is not None \
and isinstance(media_data_obj, media.Folder) \
and media_data_obj.fixed_flag \
and (
media_data_obj is self.fixed_all_folder \
or media_data_obj is self.fixed_bookmark_folder \
or media_data_obj is self.fixed_fav_folder \
or media_data_obj is self.fixed_live_folder \
or media_data_obj is self.fixed_missing_folder \
or media_data_obj is self.fixed_new_folder \
or media_data_obj is self.fixed_recent_folder \
or media_data_obj is self.fixed_waiting_folder \
or media_data_obj is self.fixed_temp_folder \
or media_data_obj is self.fixed_misc_folder \
or media_data_obj is self.fixed_clips_folder
):
return True
else:
return False
def delete_temp_folders(self):
"""Called by self.stop_continue() and self.load_db().
Deletes the contents of any folders marked temporary, such as the
'Temporary Videos' folder. (The folders themselves are not deleted).
"""
# (Must compile a list of top-level container objects first, or Python
# will complain about the dictionary changing size)
obj_list = []
for dbid in self.media_name_dict.values():
obj_list.append(self.media_reg_dict[dbid])
for media_data_obj in obj_list:
if isinstance(media_data_obj, media.Folder) \
and media_data_obj.temp_flag:
# Delete all child objects
for child_obj in list(media_data_obj.child_list.copy()):
if isinstance(child_obj, media.Video):
self.delete_video(child_obj)
else:
self.delete_container(child_obj)
# Remove files from the filesystem, leaving an empty directory
dir_path = media_data_obj.get_default_dir(self)
if os.path.isdir(dir_path):
self.remove_directory(dir_path)
self.make_directory(dir_path)
def open_temp_folders(self):
"""Called by self.stop_continue().
Checks all folders marked temporary. Any of them that contain videos
are opened on the desktop (so the user can more conveniently copy
things out of them, before they are deleted.)
"""
for dbid in self.media_name_dict.values():
media_data_obj = self.media_reg_dict[dbid]
if isinstance(media_data_obj, media.Folder) \
and media_data_obj.temp_flag \
and media_data_obj.child_list:
utils.open_file(self, media_data_obj.get_default_dir(self))
def disable_load_save(self, error_msg=None, lock_flag=False):
"""Called by self.load_config(), .save_config(), load_db() and
.save_db().
After an error, disables loading/saving, and desensitises many widgets
in the main window.
Args:
error_msg (str or None): An optional error message that can be
retrieved later, if required
lock_flag (bool): True when the error was caused by being unable to
load a database file because of a lockfile; in which the user
is prompted if they want to remove it, or not
"""
# This flag is used to detect an interrupted database load due to a
# Python error, which would mean that the call to self.load_db()
# never returns
# It is set back to False whenever that function returns, which is
# often directly after a call to this function
self.db_loading_flag = False
# Ignore subsequent calls to this function; only the initial error
# is of interest
if not self.disable_load_save_flag:
self.disable_load_save_flag = True
self.allow_db_save_flag = False
self.disable_load_save_msg = error_msg
self.disable_load_save_lock_flag = lock_flag
# (Check both that the window exists, and that some widgets have
# been drawn in it, before trying to desensitise those widgets)
if self.main_win_obj is not None \
and self.main_win_obj.grid is not None:
self.main_win_obj.sensitise_widgets_if_database(False)
def disable_scheduled_dl(self):
"""Called by self.save_db() only.
After a failure to save a database file, file load/save is not
disabled altogether, but scheduled downloads are.
Set the flag to do that, and also show a message in the Errors/
Warnings tab.
"""
self.disable_scheduled_dl_flag = True
self.system_error(
105,
'After failing to save the database file, scheduled downloads' \
+ ' have been disabled',
)
def remove_db_lock_file(self):
"""Called by self.do_shutdown(), .stop_continue(), .load_db() and
.switch_db().
Removes the lockfile protecting the Tartube database file, and updates
IVs.
"""
if self.db_lock_file_path is not None:
if os.path.isfile(self.db_lock_file_path):
self.remove_file(self.db_lock_file_path)
self.db_lock_file_path = None
def remove_stale_lock_file(self):
"""Called by self.start() (only), after a call to
mainwin.RemoveLockFileDialogue.
The user has confirmed that the lockfile protecting a Tartube database
file is stale, and can be removed; so remove it.
"""
lock_path = os.path.abspath(
os.path.join(self.data_dir, self.db_file_name + '.lock'),
)
if os.path.exists(lock_path):
self.remove_file(lock_path)
def file_error_dialogue(self, msg):
"""Called by self.start(), .save_config(), load_db() and .save_db().
After a failure to load/save a file, display a dialogue window if the
main window is open, or write to the terminal if not.
Args:
msg (str): The message to display
"""
if self.main_win_obj and self.dialogue_manager_obj:
self.dialogue_manager_obj.show_msg_dialogue(msg, 'error', 'ok')
else:
# Main window not open yet, so remove any newline characters
# (which look weird when printed to the terminal)
msg = re.sub(
r'\n',
' ',
msg,
)
print('FILE ERROR: ' + msg)
def make_directory(self, dir_path):
"""Can be called by anything.
The call to os.makedirs() might fail with a 'Permission denied' error,
meaning that the specified directory is unwriteable.
Convenience function to intercept the error, and display a system error
in response.
Args:
dir_path (str): The full path to the directory to be created with a
call to os.makedirs()
Returns:
True if the directory was created, False if not
"""
try:
os.makedirs(dir_path)
return True
except:
# Show a system error
self.system_error(
106,
'Failed to create directory \'' + dir_path + '\'',
)
return False
def remove_directory(self, dir_path):
"""Can be called by anything.
The call to shutil.rmtree() might fail.
Convenience function to intercept the error, and display a system error
in response.
Args:
dir_path (str): The full path to the directory to be removed with a
call to shutil.rmtree()
Returns:
True if the directory was removed, False if not
"""
try:
shutil.rmtree(dir_path)
return True
except:
# Show a system error
self.system_error(
107,
'Failed to remove directory \'' + dir_path + '\'',
)
return False
def remove_file(self, file_path):
"""Can be called by anything.
The call to os.remove() might fail.
Convenience function to intercept the error, and display a system error
in response.
Args:
file_path (str): The full path to the file to be removed with a
call to os.remove()
Returns:
True if the file was removed, False if not
"""
try:
os.remove(file_path)
return True
except:
# Show a system error
self.system_error(
108,
'Failed to remove file \'' + file_path + '\'',
)
return False
def move_file_or_directory(self, old_path, new_path):
"""Can be called by anything.
The call to shutil.move() might fail.
Convenience function to intercept the error, and display a system error
in response.
Args:
old_path (str): The current full path of the file or directory
new_path (str): The new full path of the file or directory
Returns:
True if the file/directory was moved, False if not
"""
try:
shutil.move(old_path, new_path)
return True
except:
# Show a system error
self.system_error(
109,
'Failed to move file/directory \'' + old_path + '\' to \'' \
+ new_path + '\'',
)
return False
def make_semaphore_file(self, dir_path):
"""Can be called by anything.
Currently called to create a semaphore file in an external directory
(i.e. one outside of Tartube's data directory). The semaphore file is
used to test that the directory is readable/writeable, before using it
to store videos.
The specified 'dir_path' must already exist.
Args:
dir_path (str): The full path to the directory in which the
semaphore file should be created
Returns:
Full path to the semaphore file if it was created or already
exists, None if the specified directory doesn't exist, or if
the semaphore file doesn't exist and can't be created
"""
# e.g. .tartube.sem
file_path = os.path.abspath(
os.path.join(dir_path, '.' + __main__.__packagename__ + '.sem'),
)
if not os.path.isdir(dir_path):
return None
elif os.path.isfile(file_path):
return file_path
try:
fh = open(file_path, 'w')
fh.close()
return file_path
except:
# Show a system error
self.system_error(
110,
'Failed to write files to directory \'' + dir_path + '\'',
)
return None
def move_backup_files(self):
"""Called by self.load_db().
Before v1.3.099, Tartube's data directory used a different structure,
with the database backup files stored in self.data_dir itself.
After v1.3.099, they are stored in self.backup_dir.
The calling function has detected that the old file structure is being
used. As a convenience to the user, move all the backup files to their
new location.
"""
try:
file_list = os.listdir(path=self.data_dir)
except:
return
for filename in file_list:
if re.search(r'^tartube_BU_.*\.db$', filename):
old_path = os.path.abspath(
os.path.join(self.data_dir, filename),
)
new_path = os.path.abspath(
os.path.join(self.backup_dir, filename),
)
utils.rename_file(self, old_path, new_path)
def open_wiz_win(self):
"""Called by self.start() when no configuration file exists (meaning
this is probably a new Tartube installation).
Called by self.load_config() if the config file exists in the Tartube
directory, but is unreadable (meaning that the user has created a
blank config file there, in order to force the new Tartube installation
to use that directory).
Open the wizard window, so the user can set the data directory, specify
which fork of youtube-dl to use, and (depending on the system) download
and install youtube-dl and/or FFmpeg
"""
# Open the wizard window. When it closes, self.open_wiz_win_continue()
# is called
wizwin.SetupWizWin(self)
def open_wiz_win_continue(self):
"""Called by wizwin.SetupWizWin.apply_changes().
For a new installation, the user has specified various settings. Create
the config file, then continue the setup process.
"""
# Once again, auto-detect the location of youtube-dl (or its fork),
# now that the user has chosen one
self.auto_detect_paths()
# Setup wizard window was completed. Create a new config file
self.save_config()
# Resume general initialisation. The True flag means that a new config
# file was created
self.start_continue(True)
def prompt_user_for_data_dir(self):
"""Called by mainwin.MountDriveDialogue.do_select_dir().
When the user wants to specify a non-default location for Tartube's
data directory, prompt the user to select/create a directory.
Returns:
True if the user selects a location, False if they do not
"""
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Please select Tartube\'s data folder'),
self.main_win_obj,
'folder',
)
# Get the user's response
response = dialogue_win.run()
if response == Gtk.ResponseType.OK:
self.data_dir = dialogue_win.get_filename()
self.data_dir_alt_list = [ self.data_dir ]
self.update_data_dirs()
dialogue_win.destroy()
if response == Gtk.ResponseType.OK:
# Location selected; the remaining code in self.start() will
# create the data directory, if necessary
return True
else:
# Location not selected. Tartube will now shut down
return False
def check_downloader(self, arg, wiz_win_obj=None):
"""Called by several functions as they prepare a system command to
execute.
The specified value is one of the arguments in the system command,
containing the text 'youtube-dl'.
If self.ytdl_fork is specified, substitutes the fork for the original,
and returns the modified value.
If the specified value doesn't actually contain 'youtube-dl', or if the
user has specified a custom path to the youtube-dl(c) executable, then
'arg' is returned unmodified.
Args:
arg (str): An argument in a system command, which should contain
'youtube-dl'
wiz_win_obj (wizwin.SetupWizWin or None): If called from the setup
wizard window, uses its IV, rathern than ours
Returns:
The modified (or original) value
"""
if not wiz_win_obj:
if self.ytdl_path_custom_flag:
if re.search('youtube-dl', arg) \
and self.ytdl_path is not None:
return self.ytdl_path
else:
# Failsafe
return arg
elif self.ytdl_fork is not None:
return re.sub('youtube-dl', self.ytdl_fork, arg)
else:
return arg
else:
if wiz_win_obj.ytdl_fork is not None:
return re.sub('youtube-dl', wiz_win_obj.ytdl_fork, arg)
else:
return arg
def get_downloader(self, wiz_win_obj=None):
"""Can be called by anything.
If a youtube-dl fork (self.ytdl_fork) has been specified, returns it.
Otherwise returns the string 'youtube-dl' (self.ytdl_bin).
Args:
wiz_win_obj (wizwin.SetupWizWin or None): If called from the setup
wizard window, uses its IV, rathern than ours
Returns:
The string described above
"""
if not wiz_win_obj:
if self.ytdl_fork is not None:
return self.ytdl_fork
else:
return self.ytdl_bin
else:
if wiz_win_obj.ytdl_fork is not None:
return wiz_win_obj.ytdl_fork
else:
return self.ytdl_bin
def retrieve_videos_from_db(self, data_list, dummy_flag=False):
"""Can be called by anything.
Given a list of data, which can contain a mix of full paths to a video/
audio file and/or URLs, searches the media data registry for a
matching media.Video objects.
Optionally checks the list of 'dummy' media.Video objects maintained
by mainwin.MainWin, too.
Returns a list of matching media.Video objects (without duplicates).
Args:
data_list (list): A list of full paths and/or URLs
Return values:
A list of matching media.Video objects
"""
return_list = []
# Search the media data registry
for media_data_obj in self.media_reg_dict.values():
if isinstance(media_data_obj, media.Video):
source = media_data_obj.source
if media_data_obj.file_name is not None:
path = media_data_obj.get_actual_path(self)
else:
path = None
for data in data_list:
if data is not None \
and data != '' \
and (
(source is not None and source == data)
or (path is not None and path == data)
):
return_list.append(media_data_obj)
break
if dummy_flag:
# Search the list of 'dummy' media.Video objects created by the
# Classic Mode tab
for video_obj in self.main_win_obj.classic_media_dict.values():
source = video_obj.source
path = video_obj.get_actual_path(self)
for data in data_list:
if data is not None \
and data != '' \
and (
(source is not None and source == data)
or (path is not None and path == data)
) and not video_obj in return_list:
return_list.append(video_obj)
break
return return_list
def get_proxy(self):
"""Called by options.OptionsParser.build_proxy().
self.dl_proxy_cycle_list() specifies a list of proxies which can be
passed to youtube-dl(c) as the --proxy option.
So that the user can cycle through the list of proxies, return the
item at the top of the list (if any), having moved it to the bottom of
the list.
Return values;
The URL to a proxy, or None
"""
if not self.dl_proxy_list:
return None
else:
proxy = self.dl_proxy_list.pop(0)
self.dl_proxy_list.append(proxy)
return proxy
def apply_locale(self):
"""Called by self.start() and .load_config().
Calls the python gettext module to apply the locale specified by
self.custom_locale (which may have been selected by the user, but it
otherwise determined by the system).
"""
# Git #245. #247, crash when the gettext.translation() call fails
success_flag = False
if self.custom_locale in formats.LOCALE_LIST:
try:
LOCALE = gettext.translation(
'base',
localedir='locale',
languages=[self.custom_locale],
)
LOCALE.install()
# (Apply to this file)
_ = LOCALE.gettext
# (Apply to other files)
config._ = _
downloads._ = _
formats._ = _
info._ = _
mainwin._ = _
media._ = _
process._ = _
refresh._ = _
tidy._ = _
updates._ = _
utils._ = _
wizwin._ = _
# (Update download operation stages, e.g.
# formats.MAIN_STAGE_QUEUED
formats.do_translate(True)
success_flag = True
except:
pass
if not success_flag:
# Locale is invalid, or Tartube does not provide translations for
# it; so use the default locale instead
self.custom_locale = formats.LOCALE_DEFAULT
# (Operations)
def download_manager_start(self, operation_type, \
automatic_flag=False, media_data_list=[], custom_dl_obj=None):
"""Can be called by anything.
Creates a new downloads.DownloadManager object to handle the download
operation. When the operation is complete,
self.download_manager_finished() is called.
Args:
operation_type (str): 'sim' if channels/playlists should just be
checked for new videos, without downloading anything. 'real'
if videos should be downloaded (or not) depending on each media
data object's .dl_sim_flag IV
'custom_real' is like 'real', but with additional options
applied (specified by a downloads.CustomDLManager object).
A 'custom_real' operation is sometimes preceded by a
'custom_sim' operation (which is the same as a 'sim' operation,
except that it is always followed by a 'custom_real'
operation)
For downloads launched from the Classic Mode tab,
'classic_real' for an ordinary download, or 'classic_custom'
for a custom download. A 'classic_custom' operation is always
preceded by a 'classic_sim' operation (which is the same as a
'sim' operation, except that it is always followed by a
'classic_custom' operation)
automatic_flag (bool): True when called by
self.script_slow_timer_callback(). When set, dialogue windows
are not displayed (as they ordinarly would be).
media_data_list (list): List of media.Video, media.Channel,
media.Playlist and/or media.Folder objects. Can also be a list
of (exclusively) media.Scheduled objects. If not an empty list,
only the specified media data objects (and their children) are
checked/downloaded. If an empty list, all media data objects
are checked/downloaded. If operation_type is 'classic_real',
'classic_sim' or 'classic_custom', then the media_data_list can
contain a list of dummy media.Video objects created by an
earlier call to this function; if the list is empty, all
dummy media.Video objects in mainwin.MainWin.classic_media_dict
are downloaded
custom_dl_obj (downloads.CustomDLManager or None): The custom
download manager that applies to this download operation. Only
specified when 'operation_type' is 'custom_sim', 'custom_real',
'classic_sim' or 'classic_real'
For 'custom_real' and 'classic_real', not specified if
self.temp_stamp_list or self.temp_slice_list are specified
(because those values take priority)
For 'custom_real', not specified if media_data_list contains
media.Scheduled objects
"""
# Check for interrupted database loads
if self.db_loading_flag:
self.disable_load_save()
self.system_error(
111,
'Cannot start the download operation because Tartube failed' \
+ ' to finish loading a database (which seems to be broken)',
)
return
# Code to deal with calls from self.script_slow_timer_callback()
if media_data_list:
first_obj = media_data_list[0]
if isinstance(first_obj, media.Scheduled):
# If the first item in the list is a media.Scheduled object,
# then they all should be
for scheduled_obj in media_data_list:
if not isinstance(scheduled_obj, media.Scheduled):
self.system_error(
112,
'Unexpected item in scheduled download list',
)
return
# If a media.Scheduled object which wants to start a
# 'custom_real' download exists in 'media_data_list', it
# should be the only one there
if first_obj.dl_mode == 'custom_real' \
and first_obj.custom_dl_uid is not None \
and len(media_data_list) > 1:
if not isinstance(scheduled_obj, media.Scheduled):
self.system_error(
113,
'Unexpected item in scheduled download list',
)
return
# Set the time at which this scheduled download began
for scheduled_obj in media_data_list:
scheduled_obj.set_last_time(int(time.time()))
# Convert the 'operation_type' for this download operation from
# 'custom_real' to 'custom_sim' or 'real', as required
if first_obj.dl_mode == 'custom_real':
if first_obj.custom_dl_uid is None \
or not first_obj.custom_dl_uid in self.custom_dl_reg_dict:
# Fallback
operation_type = 'real'
elif not custom_dl_obj:
custom_dl_obj \
= self.custom_dl_reg_dict[first_obj.custom_dl_uid]
if custom_dl_obj.dl_by_video_flag \
and custom_dl_obj.dl_precede_flag:
operation_type = 'custom_sim'
# If a livestream operation is running, tell it to stop immediately
if self.livestream_manager_obj:
self.livestream_manager_obj.stop_livestream_operation()
# If using a no-download package, then videos can't be downloaded
if __main__.__pkg_no_download_flag__ \
and operation_type != 'sim' \
and operation_type != 'classic_sim':
self.system_error(
114,
'This Tartube package cannot be used to download videos',
)
return
# If a livestream operation was running, this IV should already have
# been reset
elif self.current_manager_obj:
# Operation already in progress
if not automatic_flag:
self.system_error(
115,
'An operation is already in progress',
)
return
elif self.main_win_obj.config_win_list:
# Download operation is not allowed when a configuration window is
# open
if not automatic_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'A download operation cannot start if one or more' \
+ ' configuration windows are still open',
),
'error',
'ok',
)
return
# If the device containing self.data_dir is running low on space,
# warn the user before proceeding
disk_space = utils.disk_get_free_space(self.data_dir)
total_space = utils.disk_get_total_space(self.data_dir)
if (
self.disk_space_stop_flag \
and self.disk_space_stop_limit != 0 \
and disk_space <= self.disk_space_stop_limit
) or disk_space < self.disk_space_abs_limit:
# Refuse to proceed with the operation
if not automatic_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'You only have {0} / {1} Gb remaining on your device',
).format(str(disk_space), str(total_space)),
'error',
'ok',
None, # Parent window is main window
)
return
elif self.disk_space_warn_flag \
and self.disk_space_warn_limit != 0 \
and disk_space <= self.disk_space_warn_limit:
if automatic_flag:
# Don't perform a scheduled download operation if disk space is
# below the limit at which a warning would normally be issued
return
else:
# Warn the user that their free disk space is running low, and
# get confirmation before starting the download operation
self.dialogue_manager_obj.show_msg_dialogue(
_(
'You only have {0} / {1} Gb remaining on your device',
).format(str(disk_space), str(total_space)) \
+ '\n\n' \
+ _('Are you sure you want to continue?'),
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .download_manager_continue()
{
'yes': 'download_manager_continue',
'data': [
operation_type,
automatic_flag,
media_data_list,
custom_dl_obj,
],
},
)
else:
# Start the download operation immediately
self.download_manager_continue([
operation_type,
automatic_flag,
media_data_list,
custom_dl_obj,
])
def download_manager_continue(self, arg_list):
"""Called by self.download_manager_start() and
.update_manager_finished().
Having obtained confirmation from the user (if required), start the
download operation.
Args:
arg_list (list): List of arguments originally supplied to
self.download_manager_start(). A list in the form
[ operation_type, automatic_flag, media_data_list,
custom_dl_obj ]
"""
# Extract arguments from arg_list
operation_type = arg_list.pop(0)
automatic_flag = arg_list.pop(0)
media_data_list = arg_list.pop(0)
custom_dl_obj = arg_list.pop(0)
# When not called by the Classic Mode tab:
#
# The media data registry consists of a collection of media data
# objects (media.Video, media.Channel, media.Playlist and
# media.Folder)
# If a list of media data objects was specified by the calling
# function, those media data object and all of their descendants are
# are assigned a downloads.DownloadItem object. If that list instead
# contains media.Scheduled objects, then those objects specify the
# media data objects to download
# Otherwise, all media data objects are assigned a
# downloads.DownloadItem object
# Those downloads.DownloadItem objects are collectively stored in a
# downloads.DownloadList object
#
# When called by the Classic Mode tab:
#
# The user has added one or more URLs to the tab's download list and,
# in response, Tartube has created a number of dummy media.Video
# objects (which have not been added to the media data registry).
# Each dummy object corresponds to a single URL (which might
# represent a video, channel or playlist)
# If a list of dummy media.Video objects was specified by the calling
# function, they are downloaded. Otherwise all dummy media.Video
# objects are downloaded
download_list_obj = downloads.DownloadList(
self,
operation_type,
media_data_list,
custom_dl_obj,
)
if not download_list_obj.download_item_list:
if not automatic_flag:
if operation_type == 'classic_real' \
or operation_type == 'classic_sim' \
or operation_type == 'classic_custom':
msg = _(
'1. Copy URLs into the box at the top' \
+ '\n2. Select a destination and a format' \
+ '\n3. Click \'Add URLs\'' \
+ '\n4. Click \'Download all\'',
)
elif operation_type == 'sim':
msg = _('There is nothing to check!')
else:
msg = _('There is nothing to download!')
self.dialogue_manager_obj.show_simple_msg_dialogue(
msg,
'error',
'ok',
)
return
# If the flag is set, do an update operation before starting the
# download operation
if self.operation_auto_update_flag and not self.operation_waiting_flag:
self.update_manager_start('ytdl')
# These IVs tells self.update_manager_finished to start a download
# operation
self.operation_waiting_flag = True
self.operation_waiting_type = operation_type
self.operation_waiting_list = media_data_list
self.operation_waiting_obj = custom_dl_obj
return
# Set a list of proxies. When one is required, a call to
# self.get_proxy() returns the item at the top of the list, and moves
# it to the bottom of the list
self.dl_proxy_cycle_list = self.dl_proxy_list.copy()
# Remove videos from the 'Recent Videos' folder, so it can be re-filled
# by any videos checked/downloaded by this operation
# (Don't do so when the download operation was launched from the
# Classic Mode tab, or when a 'custom_sim' operation has finished and
# we're about to start a 'custom_real' operation)
if operation_type != 'classic_real' \
and operation_type != 'classic_sim' \
and operation_type != 'classic_custom' \
and (
operation_type != 'custom_real' \
or not custom_dl_obj \
or not custom_dl_obj.dl_by_video_flag \
or not custom_dl_obj.dl_precede_flag
):
remove_time = int(time.time()) \
- (self.fixed_recent_folder_days * 24 * 60 * 60)
child_list = self.fixed_recent_folder.child_list.copy()
for child_obj in child_list:
if not self.fixed_recent_folder_days \
or child_obj.receive_time < remove_time:
self.fixed_recent_folder.del_child(child_obj)
# Update the Video Index (and the Video Catalogue, if appropriate)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
self.fixed_recent_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_recent_folder,
)
if self.main_win_obj.video_index_current \
== self.fixed_recent_folder.name:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
# Reset the dictionary of channel/playlist names extracted from video
# metadata, so it can be refilled
self.media_reset_container_dict = {}
# Don't show a dialogue window at the end of a scheduled download
if automatic_flag:
self.no_dialogue_this_time_flag = True
# During a download operation, show a progress bar in the Videos tab
# (except when launched from the Classic Mode tab, in which case we
# just desensitise the existing buttons)
if operation_type == 'sim' or operation_type == 'custom_sim':
self.main_win_obj.show_progress_bar('check')
elif operation_type == 'real' or operation_type == 'custom_real':
self.main_win_obj.show_progress_bar('download')
else:
self.main_win_obj.sensitise_progress_bar(False)
# Reset the Progress List
self.main_win_obj.progress_list_reset()
# Reset the Results List
self.main_win_obj.results_list_reset()
# Reset the Output tab
self.main_win_obj.output_tab_reset_pages()
if operation_type == 'sim' \
or operation_type == 'real' \
or operation_type == 'custom_sim' \
or operation_type == 'custom_real':
# Initialise the Progress List with one row for each media data
# object in the downloads.DownloadList object
# (The Classic Progress List, if in use, has already been
# initialised)
self.main_win_obj.progress_list_init(download_list_obj)
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(False)
# Make the widget changes visible
self.main_win_obj.show_all()
# During a download operation, a GObject timer runs, so that at regular
# intervals we can update the Progress tab/Classic Progress tab, and
# the Output tab
# There is also a delay between the instant at which youtube-dl reports
# a video file has been downloaded, and the instant at which it
# appears in the filesystem. The timer checks for newly-existing
# files at regular intervals, too
# Create the timer
self.dl_timer_id = GObject.timeout_add(
self.dl_timer_time,
self.dl_timer_callback,
)
# Initiate the download operation. Any code can check whether a
# download, update or refresh operation is in progress, or not, by
# checking this IV
self.current_manager_obj = downloads.DownloadManager(
self,
operation_type,
download_list_obj,
custom_dl_obj,
)
self.download_manager_obj = self.current_manager_obj
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def download_manager_halt_timer(self):
"""Called by downloads.DownloadManager.run() when that function has
finished.
During a download operation, a GObject timer was running. Let it
continue running for a few seconds more.
"""
if self.dl_timer_id:
self.dl_timer_check_time \
= int(time.time()) + self.dl_timer_final_time
def download_manager_finished(self):
"""Called by self.dl_timer_callback() and
downloads.DownloadManager.run().
The download operation has finished, so update IVs and main window
widgets.
"""
# This function behaves differently, if the download operation was
# launched from the Classic Mode tab
operation_type = self.download_manager_obj.operation_type
if operation_type == 'clasic_sim' \
or operation_type == 'classic_real' \
or operation_type == 'classic_custom':
classic_mode_flag = True
else:
classic_mode_flag = False
# If the operation was stopped manually, don't proceed from a
# 'custom_sim' to a 'custom_real' operation, or from a
# 'classic_sim' to a 'classic_real' operation
manual_stop_flag = self.download_manager_obj.manual_stop_flag
# For 'custom_sim' operations, get the original list of media data
# objects that was passed to self.download_manager_start()
orig_media_data_list \
= self.download_manager_obj.download_list_obj.orig_media_data_list
# For Classic Mode tab custom downloads, get the list of videos which
# were extrascted, along with their metadata
classic_extract_list = self.download_manager_obj.classic_extract_list
# Get the number of videos downloaded (real and simulated), as well as
# the number of individual video clips downloaded and the number of
# video slices removed
dl_count = self.download_manager_obj.total_dl_count
sim_count = self.download_manager_obj.total_sim_count
clip_count = self.download_manager_obj.total_clip_count
slice_count = self.download_manager_obj.total_slice_count
other_count = self.download_manager_obj.other_video_count
# For the 'custom_sim'/'classic_sim' operation, we need to use the same
# custom download manager
custom_dl_obj = self.download_manager_obj.custom_dl_obj
# Get the time taken by the download operation, so we can convert it
# into a nice string below (e.g. '05:15')
# For refresh operations, refresh.RefreshManager.stop_time() might not
# have been set at this point (for some reason), so we need to check
# for the equivalent problem
if self.download_manager_obj.stop_time is not None:
time_num = int(
self.download_manager_obj.stop_time \
- self.download_manager_obj.start_time
)
else:
time_num = int(time.time() - self.download_manager_obj.start_time)
# Any code can check whether an operation is in progress, or not, by
# checking this IV
self.current_manager_obj = None
self.download_manager_obj = None
# Stop the timer and reset IVs
GObject.source_remove(self.dl_timer_id)
self.dl_timer_id = None
self.dl_timer_check_time = None
# (All videos marked to be launched in the system's default media
# player should have been launched already, but just to be safe,
# empty this list)
self.watch_after_dl_list = []
# Downloaded videos can be deleted/removed, if required. The True flag
# updates the Video Catalogue
if self.auto_delete_asap_flag:
self.auto_delete_old_videos(True)
self.auto_remove_old_videos(True)
# After a download operation, save files, if allowed (but don't bother
# when launched from the Classic Mode tab)
if not classic_mode_flag and self.operation_save_flag:
self.save_config()
self.save_db()
# After a download operation, update the status icon in the system tray
self.status_icon_obj.update_icon()
if not classic_mode_flag:
# Remove the progress bar in the Videos tab
self.main_win_obj.hide_progress_bar()
# If remaining lines in the Progress List should be hidden, hide
# them
if self.progress_list_hide_flag:
self.main_win_obj.progress_list_check_hide_rows(True)
else:
# No progress bar exists; just reset the text on the existing
# buttons, and then resensitise them
self.main_win_obj.update_free_space_msg()
self.main_win_obj.sensitise_progress_bar(True)
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(True)
# Make the widget changes visible (not necessary if the main window has
# been closed to the system tray)
if self.main_win_obj.is_visible():
self.main_win_obj.show_all()
# If Tartube is due to shut down, then shut it down
show_newbie_dialogue_flag = False
if self.halt_after_operation_flag:
self.stop_continue()
# Show a dialogue window or desktop notification, if required
elif not self.no_dialogue_this_time_flag \
and operation_type != 'custom_sim' \
and operation_type != 'classic_sim':
# If videos were expected to be checked/downloaded, but nothing
# happened, show a newbie dialogue explaining what to do next
if self.show_newbie_dialogue_flag \
and dl_count == 0 \
and sim_count == 0 \
and clip_count == 0 \
and slice_count == 0 \
and other_count == 0:
show_newbie_dialogue_flag = True
else:
if not self.operation_halted_flag:
msg = _('Download operation complete')
else:
msg = _('Download operation halted')
if dl_count or sim_count or other_count:
msg += '\n\n' + _('Videos downloaded:') + ' ' \
+ str(dl_count) + '\n' + _('Videos checked:') \
+ ' ' + str(sim_count)
if clip_count or slice_count:
msg += '\n'
if clip_count:
msg += '\n' + _('Clips downloaded:') + ' ' \
+ str(clip_count)
if slice_count:
msg += '\n' + _('Video slices removed:') + ' ' \
+ str(slice_count)
if time_num >= 10:
msg += '\n\n' + _('Time taken:') + ' ' \
+ utils.convert_seconds_to_string(time_num, True)
if self.operation_dialogue_mode == 'dialogue':
self.dialogue_manager_obj.show_simple_msg_dialogue(
msg,
'info',
'ok',
)
elif self.operation_dialogue_mode == 'desktop':
self.main_win_obj.notify_desktop(None, msg)
# In any case, reset those IVs
self.halt_after_operation_flag = False
self.no_dialogue_this_time_flag = False
# Also reset operation IVs
self.operation_halted_flag = False
# A 'classic_sim' operation is followed by a 'classic_real' operation,
# but only if some videos were extracted during the 'classic_sim'
# operation
# A 'custom_sim' operation is followed by a 'custom_real' operation in
# all cases
# Exception: If the first of the two operations was stopped manually,
# don't start the second one
# Launch the second operation, if the first has just finished
if operation_type == 'classic_sim' \
and classic_extract_list \
and not manual_stop_flag:
# The list is in groups of two, in the form
# [ parent_obj, json_dict ]
# ...where 'parent_obj' is a 'dummy' media.Video object
# representing a video, channel or playlist, from which the
# metedata for a single video, 'json_dict', has been extracted
# Create new dummy media.Video objects, one for each extracted
# video
dummy_list = []
while classic_extract_list:
parent_obj = classic_extract_list.pop(0)
json_dict = classic_extract_list.pop(0)
dummy_video_obj \
= self.main_win_obj.classic_mode_tab_create_dummy_video(
json_dict['webpage_url'],
parent_obj.dummy_dir,
parent_obj.dummy_format,
)
dummy_list.append(dummy_video_obj)
# Update the dummy video's filename/file extension, if
# available, so that clip titles can be set correctly (when
# required)
# Git #177 reports that this value might be 'None', so check
# for that
if '_filename' in json_dict \
and json_dict['_filename'] is not None:
dummy_video_obj.set_file_from_path(json_dict['_filename'])
# Update the dummy video object's metadata and/or description,
# so that its timestamp list can be set
if 'chapters' in json_dict:
dummy_video_obj.extract_timestamps_from_chapters(
self,
json_dict['chapters'],
)
elif 'description' in json_dict:
dummy_video_obj.set_video_descrip(
self,
json_dict['description'],
self.main_win_obj.descrip_line_max_len,
)
# In the Classic Progress List, remove the row for parent_obj
# (if it still exists)
if parent_obj.dbid in self.main_win_obj.classic_media_dict:
self.main_win_obj.classic_mode_tab_remove_rows(
[ parent_obj.dbid ],
)
# Start the second download operation
self.download_manager_start(
'classic_custom',
False, # Not called from a timer
dummy_list,
custom_dl_obj,
)
elif operation_type == 'custom_sim' and not manual_stop_flag:
# Start the second download operation
self.download_manager_start(
'custom_real',
False, # Not called from a timer
orig_media_data_list,
custom_dl_obj,
)
# Otherwise, show the newbie dialogue, if required
elif show_newbie_dialogue_flag \
and not self.debug_disable_newbie_flag \
and not manual_stop_flag:
dialogue_win = mainwin.NewbieDialogue(
self.main_win_obj,
classic_mode_flag,
)
dialogue_win.run()
# Retrieve user choices from the dialogue window...
newbie_update_flag = dialogue_win.update_flag
newbie_config_flag = dialogue_win.config_flag
newbie_change_flag = dialogue_win.change_flag
newbie_website_flag = dialogue_win.website_flag
newbie_issues_flag = dialogue_win.issues_flag
self.show_newbie_dialogue_flag = dialogue_win.show_flag
dialogue_win.destroy()
if newbie_update_flag:
self.update_manager_start('ytdl')
elif newbie_config_flag:
config.SystemPrefWin(self.main_win_obj.app_obj, 'paths')
elif newbie_change_flag:
config.SystemPrefWin(self.main_win_obj.app_obj, 'forks')
elif newbie_website_flag:
utils.open_file(self, __main__.__website__)
elif newbie_issues_flag:
utils.open_file(self, __main__.__website_bugs__)
def update_manager_start(self, update_type):
"""Can be called by anything.
Initiates an update operation to do one of two jobs:
1. Install youtube-dl (or a fork of it), or update it to its most
recent version.
2. Install FFmpeg, matplotlib or streamlink (on MS Windows only)
Creates a new updates.UpdateManager object to handle the update
operation. When the operation is complete,
self.update_manager_finished() is called.
Args:
update_type (str): 'ffmpeg' to install FFmpeg, 'matplotlib' to
install matplotlib, 'streamlink' to install streamlinkg, or
'ytdl' to install/update youtube-dl (or a fork of it)
"""
# Check for interrupted database loads
if self.db_loading_flag:
self.disable_load_save()
self.system_error(
116,
'Cannot start the update operation because Tartube failed' \
+ ' to finish loading a database (which seems to be broken)',
)
return
# If a livestream operation is running, tell it to stop immediately
if self.livestream_manager_obj:
self.livestream_manager_obj.stop_livestream_operation()
# If a livestream operation was running, this IV should now be reset
if self.current_manager_obj:
# Operation already in progress
return self.system_error(
117,
'Operation already in progress',
)
elif self.main_win_obj.config_win_list:
# Update operation is not allowed when a configuration window is
# open
self.dialogue_manager_obj.show_msg_dialogue(
_(
'An update operation cannot start if one or more' \
+ ' configuration windows are still open',
),
'error',
'ok',
)
return
elif __main__.__pkg_strict_install_flag__:
# Update operation is disabled in the Debian/RPM package. It should
# not be possible to call this function, but we'll show an error
# message anyway
return self.system_error(
118,
'Update operations are disabled in this version of Tartube',
)
elif update_type == 'ffmpeg' and os.name != 'nt':
# The update operation can only install FFmpeg on the MS Windows
# installation of Tartube. It should not be possible to call this
# function, but we'll show an error message anyway
return self.system_error(
119,
'Update operation cannot install FFmpeg on your operating' \
+ ' system',
)
elif update_type == 'matplotlib' and os.name != 'nt':
# The same applies to matplotlib
return self.system_error(
120,
'Update operation cannot install matplotlib on your' \
+ ' operating system',
)
elif update_type == 'streamlink' and os.name != 'nt':
# The same applies to streamlink
return self.system_error(
121,
'Update operation cannot install streamlink on your' \
+ ' operating system',
)
# During an update operation, certain widgets are modified and/or
# desensitised
self.main_win_obj.sensitise_check_dl_buttons(False, update_type)
self.main_win_obj.output_tab_reset_pages()
if self.auto_switch_output_flag:
self.main_win_obj.output_tab_show_first_page()
# During an update operation, a GObject timer runs, so that the Output
# tab can be updated at regular intervals
# Create the timer
self.update_timer_id = GObject.timeout_add(
self.update_timer_time,
self.update_timer_callback,
)
# Initiate the update operation. Any code can check whether a
# download, update or refresh operation is in progress, or not, by
# checking this IV
self.current_manager_obj = updates.UpdateManager(self, update_type)
self.update_manager_obj = self.current_manager_obj
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def update_manager_start_from_wizwin(self, wiz_win_obj, update_type):
"""Called by the setup wizard window, before the (real) main window has
been created.
Initiates an update operation to do one of two jobs:
1. Install youtube-dl (or a fork of it), or update it to its most
recent version.
2. Install FFmpeg (on MS Windows only; at the moment, the wizard
window does not try to install matplotlib or streamlink)
Creates a new updates.UpdateManager object to handle the update
operation. When the operation is complete,
self.update_manager_finished() is called.
Args:
wiz_win_obj (wizwin.SetupWizWin): The calling window
update_type (str): 'ffmpeg' to install FFmpeg, or 'ytdl' to
install/update youtube-dl
Return values:
True if we attempted to start the update operation, False if not
"""
if self.current_manager_obj \
or __main__.__pkg_strict_install_flag__ \
or update_type == 'ffmpeg' and os.name != 'nt':
return False
# During an update operation, a GObject timer runs, so that the Output
# tab can be updated at regular intervals
# Create the timer
self.update_timer_id = GObject.timeout_add(
self.update_timer_time,
self.update_timer_callback,
)
# Initiate the update operation. Any code can check whether a
# download, update or refresh operation is in progress, or not, by
# checking this IV
self.current_manager_obj = updates.UpdateManager(
self,
update_type,
wiz_win_obj,
)
self.update_manager_obj = self.current_manager_obj
return True
def update_manager_halt_timer(self):
"""Called by updates.UpdateManager.install_ffmpeg(),
.install_matplotlib(), .install_streamlink or .install_ytdl() when
those functions have finished.
During an update operation, a GObject timer was running. Let it
continue running for a few seconds more.
"""
if self.update_timer_id:
self.update_timer_check_time \
= int(time.time()) + self.update_timer_final_time
def update_manager_finished(self):
"""Called by self.update_timer_callback().
The update operation has finished, so update IVs and main window
widgets.
"""
global HAVE_MATPLOTLIB_FLAG
# Import IVs from updates.UpdateManager, before it is destroyed
update_type = self.update_manager_obj.update_type
wiz_win_obj = self.update_manager_obj.wiz_win_obj
success_flag = self.update_manager_obj.success_flag
ytdl_version = self.update_manager_obj.ytdl_version
# Any code can check whether an operation is in progress, or not, by
# checking this IV
self.current_manager_obj = None
self.update_manager_obj = None
# Stop the timer and reset IVs
GObject.source_remove(self.update_timer_id)
self.update_timer_id = None
self.update_timer_check_time = None
# If this is the first successful update operation, auto-detect
# youtube-dl's actual location (but not on MS Windows, for which the
# location is set in stone)
if success_flag and not self.ytdl_update_once_flag:
self.ytdl_update_once_flag = True
# (When called from the setup wizard window, this is not done until
# later)
if os.name != 'nt' and not wiz_win_obj:
self.auto_detect_paths()
# If matplotlib is successfully installed, update the setting
if update_type == 'matplotlib' and success_flag:
HAVE_MATPLOTLIB_FLAG = True
# After an update operation, save files, if allowed
if not wiz_win_obj:
if self.operation_save_flag:
self.save_config()
self.save_db()
# During an update operation, certain widgets are modified and/or
# desensitised; restore them to their original state
self.main_win_obj.sensitise_check_dl_buttons(True)
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
# Then show a dialogue window/desktop notification, if allowed (and if
# a download operation is not waiting to start)
if update_type == 'ffmpeg' \
or update_type == 'matplotlib' \
or update_type == 'streamlink':
if not success_flag:
msg = _('Installation failed')
else:
msg = _('Installation complete')
else:
if not success_flag:
msg = _('Update operation failed')
elif self.operation_halted_flag:
msg = _('Update operation halted')
else:
msg = _('Update operation complete') \
+ '\n\n' + self.get_downloader(wiz_win_obj) + ' ' \
+ _('version:') + ' '
if ytdl_version is not None:
msg += ytdl_version
else:
msg += _('(unknown)')
if wiz_win_obj:
if update_type == 'ytdl':
wiz_win_obj.downloader_fetch_finished(msg)
else:
wiz_win_obj.ffmpeg_fetch_finished(msg)
elif self.operation_dialogue_mode != 'default' \
and not self.operation_waiting_flag:
if self.operation_dialogue_mode == 'dialogue':
self.dialogue_manager_obj.show_msg_dialogue(msg, 'info', 'ok')
elif self.operation_dialogue_mode == 'desktop':
self.main_win_obj.notify_desktop(None, msg)
# Reset operation IVs
self.operation_halted_flag = False
# If a download operation is waiting to start, start it
if self.operation_waiting_flag:
self.download_manager_continue(
[
self.operation_waiting_type,
False,
self.operation_waiting_list,
self.operation_waiting_obj,
],
)
# Reset those IVs, ready for any future download operations
self.operation_waiting_flag = False
self.operation_waiting_type = None
self.operation_waiting_list = []
self.operation_waiting_obj = None
def refresh_manager_start(self, media_data_obj=None):
"""Can be called by anything.
Initiates a refresh operation to compare Tartube's data directory with
the media registry, updating the registry as appropriate.
Creates a new refresh.RefreshManager object to handle the refresh
operation. When the operation is complete,
self.refresh_manager_finished() is called.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder or
None): If specified, only this channel/playlist/folder is
refreshed. If not specified, the entire media registry is
refreshed
"""
# Check for interrupted database loads
if self.db_loading_flag:
self.disable_load_save()
self.system_error(
122,
'Cannot start the refresh operation because Tartube failed' \
+ ' to finish loading a database (which seems to be broken)',
)
return
# If a livestream operation is running, tell it to stop immediately
if self.livestream_manager_obj:
self.livestream_manager_obj.stop_livestream_operation()
# If a livestream operation was running, this IV should now be reset
if self.current_manager_obj:
# Operation already in progress
return self.system_error(
123,
'Operation already in progress',
)
elif media_data_obj is not None \
and isinstance(media_data_obj, media.Video):
return self.system_error(
124,
'Refresh operation cannot be applied to an individual video',
)
elif self.main_win_obj.config_win_list:
# Refresh operation is not allowed when a configuration window is
# open
self.dialogue_manager_obj.show_msg_dialogue(
_(
'A refresh operation cannot start if one or more' \
+ ' configuration windows are still open',
),
'error',
'ok',
)
return
# The user might not be aware of what a refresh operation is, or the
# effect it might have on Tartube's database
# Warn them, and give them the opportunity to back out
msg = _(
'During a refresh operation, Tartube analyses its data folder,' \
+ ' looking for videos that haven\'t yet been added to its' \
+ ' database',
) + '\n\n' + _(
'You only need to perform a refresh operation if you have' \
+ ' manually copied videos into Tartube\'s data folder',
) + '\n\n'
if not media_data_obj:
msg += _(
'Before starting a refresh operation, you should click the' \
+ ' \'Check all\' button in the main window',
)
elif isinstance(media_data_obj, media.Channel):
msg += _(
'Before starting a refresh operation, you should right-click' \
+ ' the channel and select \'Check channel\'',
)
elif isinstance(media_data_obj, media.Playlist):
msg += _(
'Before starting a refresh operation, you should right-click' \
+ ' the playlist and select \'Check playlist\'',
)
else:
msg += _(
'Before starting a refresh operation, you should right-click' \
+ ' the folder and select \'Check folder\'',
)
msg += '\n\n' + _(
'Are you sure you want to proceed with the refresh operation?',
)
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .move_container_to_top_continue()
{
'yes': 'refresh_manager_continue',
'data': media_data_obj,
},
)
def refresh_manager_continue(self, media_data_obj=None):
"""Called by self.refresh_manager_start().
Having obtained confirmation from the user, start the refresh
operation.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder or
None): If specified, only this channel/playlist/folder is
refreshed. If not specified, the entire media registry is
refreshed
"""
# During a refresh operation, show a progress bar in the Videos tab
self.main_win_obj.show_progress_bar('refresh')
# Reset the Output tab
self.main_win_obj.output_tab_reset_pages()
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(False, True)
# Make the widget changes visible
self.main_win_obj.show_all()
# During a refresh operation, a GObject timer runs, so that the Output
# tab can be updated at regular intervals
# Create the timer
self.refresh_timer_id = GObject.timeout_add(
self.refresh_timer_time,
self.refresh_timer_callback,
)
# Initiate the refresh operation. Any code can check whether a
# download, update or refresh operation is in progress, or not, by
# checking this IV
self.current_manager_obj = refresh.RefreshManager(self, media_data_obj)
self.refresh_manager_obj = self.current_manager_obj
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def refresh_manager_halt_timer(self):
"""Called by refresh.RefreshManager.run() when that function has
finished.
During a refresh operation, a GObject timer was running. Let it
continue running for a few seconds more.
"""
if self.refresh_timer_id:
self.refresh_timer_check_time \
= int(time.time()) + self.refresh_timer_final_time
def refresh_manager_finished(self):
"""Called by self.refresh_timer_callback().
The refresh operation has finished, so update IVs and main window
widgets.
"""
# Get the time taken by the refresh operation, so we can convert it
# into a nice string below (e.g. '05:15')
# For some reason, RefreshManager.stop_time() might not be set, so we
# need to check for that
if self.refresh_manager_obj.stop_time is not None:
time_num = int(
self.refresh_manager_obj.stop_time \
- self.refresh_manager_obj.start_time
)
else:
time_num = int(time.time() - self.refresh_manager_obj.start_time)
# Any code can check whether a download/update/refresh/info/tidy
# operation is in progress, or not, by checking this IV
self.current_manager_obj = None
self.refresh_manager_obj = None
# Stop the timer and reset IVs
GObject.source_remove(self.refresh_timer_id)
self.refresh_timer_id = None
self.refresh_timer_check_time = None
# After a refresh operation, save files, if allowed
if self.operation_save_flag:
self.save_config()
self.save_db()
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
# Remove the progress bar in the Videos tab
self.main_win_obj.hide_progress_bar()
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(True)
# Make the widget changes visible (not necessary if the main window has
# been closed to the system tray)
if self.main_win_obj.is_visible():
self.main_win_obj.show_all()
# Then show a dialogue window/desktop notification, if allowed
if self.operation_dialogue_mode != 'default':
if not self.operation_halted_flag:
msg = _('Refresh operation complete')
else:
msg = _('Refresh operation halted')
if time_num >= 10:
msg += '\n\n' + _('Time taken:') + ' ' \
+ utils.convert_seconds_to_string(time_num, True)
if self.operation_dialogue_mode == 'dialogue':
self.dialogue_manager_obj.show_msg_dialogue(msg, 'info', 'ok')
elif self.operation_dialogue_mode == 'desktop':
self.main_win_obj.notify_desktop(None, msg)
# Reset operation IVs
self.operation_halted_flag = False
def info_manager_start(self, info_type, media_data_obj=None,
url_string=None, options_string=None):
"""Can be called by anything.
Initiates an info operation to do one of three jobs:
1. Fetch a list of available formats for a video, directly from
youtube-dl
2. Fetch a list of available subtitles for a video, directly from
youtube-dl
3. Test youtube-dl with specified download options; everything is
downloaded into a temporary directory
4. Check the Tartube website, and inform the user if a new release is
available
Creates a new info.InfoManager object to handle the info operation.
When the operation is complete, self.info_manager_finished() is
called.
Args:
info_type (str): 'formats' to fetch a list of formats, 'subs' to
fetch a list of subtitles, or 'test_ytdl' to test youtube-dl
with specified options, 'version' to check for a new release of
Tartube
media_data_obj (media.Video): For 'formats' and 'subs', the
media.Video object for which formats/subtitles should be
fetched. For 'test_ytdl', set to None
url_string (str): For 'test_ytdl', the video URL to download (can
be None or an empty string, if no download is required, for
example 'youtube-dl --version'. For 'formats' and 'subs',
set to None
options_string (str): For 'test_ytdl', a string containing one or
more youtube-dl download options. The string, generated by a
Gtk.TextView, typically contains newline and/or multiple
whitespace characters; the info.InfoManager code deals with
that. Can be None or an empty string, if no download options
are required. For 'formats' and 'subs', set to None
"""
# Check for interrupted database loads
if self.db_loading_flag:
self.disable_load_save()
self.system_error(
125,
'Cannot start the info operation because Tartube failed to' \
+ ' finish loading a database (which seems to be broken)',
)
return
# If a livestream operation is running, tell it to stop immediately
if self.livestream_manager_obj:
self.livestream_manager_obj.stop_livestream_operation()
# If a livestream operation was running, this IV should now be reset
if self.current_manager_obj:
# Operation already in progress
return self.system_error(
126,
'Operation already in progress',
)
elif info_type != 'formats' \
and info_type != 'subs' \
and info_type != 'test_ytdl' \
and info_type != 'version':
# Unrecognised argument
return self.system_error(
127,
'Invalid info operation argument',
)
elif media_data_obj is not None \
and (
not isinstance(media_data_obj, media.Video)
or not media_data_obj.source
):
# Unusable media data object
return self.system_error(
128,
'Wrong media data object type or missing source',
)
elif self.main_win_obj.config_win_list:
# Info operation is not allowed when a configuration window is open
self.dialogue_manager_obj.show_msg_dialogue(
_(
'An info operation cannot start if one or more' \
+ ' configuration windows are still open',
),
'error',
'ok',
)
return
# During an info operation, certain widgets are modified and/or
# desensitised
self.main_win_obj.output_tab_reset_pages()
self.main_win_obj.sensitise_check_dl_buttons(False, info_type)
# During an info operation, a GObject timer runs, so that the Output
# tab can be updated at regular intervals
# Create the timer
self.info_timer_id = GObject.timeout_add(
self.info_timer_time,
self.info_timer_callback,
)
# If testing youtube-dl, empty the temporary directory into which
# anything is downloaded
if info_type == 'test_ytdl':
if os.path.isdir(self.temp_test_dir) \
and self.remove_directory(self.temp_test_dir):
self.make_directory(self.temp_test_dir)
# Initiate the info operation. Any code can check whether an operation
# is in progress, or not, by checking this IV
self.current_manager_obj = info.InfoManager(
self,
info_type,
media_data_obj,
url_string,
options_string,
)
self.info_manager_obj = self.current_manager_obj
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def info_manager_halt_timer(self):
"""Called by info.InfoManager.run() when that function has finished.
During an info operation, a GObject timer was running. Let it
continue running for a few seconds more.
"""
if self.info_timer_id:
self.info_timer_check_time \
= int(time.time()) + self.info_timer_final_time
def info_manager_finished(self):
"""Called by self.info_timer_callback().
The info operation has finished, so update IVs and main window widgets.
"""
# Import IVs from info.InfoManager, before it is destroyed
video_obj = self.info_manager_obj.video_obj
info_type = self.info_manager_obj.info_type
success_flag = self.info_manager_obj.success_flag
output_list = self.info_manager_obj.output_list.copy()
url_string = self.info_manager_obj.url_string
stable_version = self.info_manager_obj.stable_version
dev_version = self.info_manager_obj.dev_version
# Any code can check whether an operation is in progress, or not, by
# checking this IV
self.current_manager_obj = None
self.info_manager_obj = None
# Stop the timer and reset IVs
GObject.source_remove(self.info_timer_id)
self.info_timer_id = None
self.info_timer_check_time = None
# After an info operation, save files, if allowed
if self.operation_save_flag:
self.save_config()
self.save_db()
# During an info operation, certain widgets are modified and/or
# desensitised; restore them to their original state
self.main_win_obj.sensitise_check_dl_buttons(True)
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
# When testing youtube-dl, and a source URL was specified by the user,
# open the temporary directory so the user can see what (if
# anything) was downloaded
if url_string is not None and url_string != '':
utils.open_file(self, self.temp_test_dir)
# Show a confirmation, if allowed
if self.operation_dialogue_mode == 'dialogue' \
and (info_type == 'formats' or info_type == 'subs') \
and success_flag:
# Show a custom dialogue window, that enables the user to modify or
# apply download options directly
dialogue_win = mainwin.FormatsSubsDialogue(
self.main_win_obj,
video_obj,
info_type,
)
response = dialogue_win.run()
dialogue_win.destroy()
elif self.operation_dialogue_mode != 'default':
# Then show a message dialogue window/desktop notification, if
# allowed
if info_type != 'version' or not success_flag:
if not success_flag:
msg = _('Operation failed')
else:
msg = _('Operation complete')
msg += '\n\n' + _('Click the Output tab to see the results')
else:
msg = ''
if stable_version is not None:
mod_stable_version = self.convert_version(stable_version)
mod_current_version \
= self.convert_version(__main__.__version__)
if mod_stable_version > mod_current_version:
msg += _('A new release is available!') + '\n\n'
else:
msg += _('Your installation is up to date!') + '\n\n'
msg += _('Installed version:') + ' v' \
+ str(__main__.__version__) + '\n\n'
if stable_version is not None:
msg += _('Stable release:') + ' v' + str(stable_version) \
+ '\n\n'
else:
msg += _('Stable release: not found') + '\n\n'
if dev_version is not None:
msg += _('Development release:') + ' v' + str(dev_version)
else:
msg += _('Development release: not found')
if self.operation_dialogue_mode == 'dialogue':
self.dialogue_manager_obj.show_msg_dialogue(msg, 'info', 'ok')
elif self.operation_dialogue_mode == 'desktop':
self.main_win_obj.notify_desktop(None, msg)
# Reset operation IVs
self.operation_halted_flag = False
def tidy_manager_start(self, choices_dict):
"""Can be called by anything.
Initiates a tidy operation to tidy up the directories used by each of
one or more media.Channel, media.Playlist and media.Folder objects.
The tidy-up process consists of one or more of the following jobs:
1. Check video files are not corrupted (and optionally delete any
that are)
2. Check that video files which should exist, actually do (and
vice-versa)
3. Delete video files, audio files, description files, metadata (JSON)
files, annotation files, thumbnail files and/or youtube-dl
archive files
Creates a new tidy.TidyManager object to handle the tidy operation.
When the operation is complete, self.tidy_manager_finished() is
called.
Args:
choices_dict (dict): A dictionary specifying the choices made by
the user in mainwin.TidyDialogue. The dictionary is in the
following format:
media_data_obj: A media.Channel, media.Playlist or media.Folder
object, or None if all channels/playlists/folders are to be
tidied up. If specified, the channel/playlist/folder and
all of its descendants are checked
corrupt_flag: True if video files should be checked for
corruption
del_corrupt_flag: True if corrupted video files should be
deleted
exist_flag: True if video files that should exist should be
checked, in case they don't (and vice-versa)
del_video_flag: True if downloaded video files should be
deleted
del_others_flag: True if all video/audio files with the same
name should be deleted (as artefacts of post-processing
with FFmpeg or AVConv)
remove_no_url_flag: True if any media.Video objects whose URL
is not set should be removed from the database (no files
are deleted)
remove_dupe_flag: True if any media.Video objects, which are
not marked as downloaded and which share a URL with
another media.Video object with the same parent and which
is marked as downloaded, should be removed from the
database (no files are deleted)
del_archive_flag: True if all youtube-dl archive files should
be deleted
move_thumb_flag: True if all thumbnail files should be moved
into a subdirectory
del_thumb_flag: True if all thumbnail files should be deleted
convert_webp_flag: True if all .webp thumbnail files should be
converted to .jpg
move_data_flag: True if description, metadata (JSON) and
annotation files should be moved into a subdirectory
del_descrip_flag: True if all description files should be
deleted
del_json_flag: True if all metadata (JSON) files should be
deleted
del_xml_flag: True if all annotation files should be deleted
"""
# Check for interrupted database loads
if self.db_loading_flag:
self.disable_load_save()
self.system_error(
129,
'Cannot start the tidy operation because Tartube failed' \
+ ' to finish loading a database (which seems to be broken)',
)
return
# If a livestream operation is running, tell it to stop immediately
if self.livestream_manager_obj:
self.livestream_manager_obj.stop_livestream_operation()
# If a livestream operation was running, this IV should now be reset
if self.current_manager_obj:
# Operation already in progress
return self.system_error(
130,
'Operation already in progress',
)
elif self.main_win_obj.config_win_list:
# Tidy operation is not allowed when a configuration window is open
if not automatic_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'A tidy operation cannot start if one or more' \
+ ' configuration windows are still open',
),
'error',
'ok',
)
return
# During a tidy operation, show a progress bar in the Videos tab
self.main_win_obj.show_progress_bar('tidy')
# Reset the Output tab
self.main_win_obj.output_tab_reset_pages()
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(False, True)
# Make the widget changes visible
self.main_win_obj.show_all()
# During a tidy operation, a GObject timer runs, so that the Output tab
# can be updated at regular intervals
# Create the timer
self.tidy_timer_id = GObject.timeout_add(
self.tidy_timer_time,
self.tidy_timer_callback,
)
# Initiate the tidy operation. Any code can check whether an operation
# is in progress, or not by checking this IV
self.current_manager_obj = tidy.TidyManager(self, choices_dict)
self.tidy_manager_obj = self.current_manager_obj
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def tidy_manager_halt_timer(self):
"""Called by tidy.TidyManager.run() when that function has finished.
During a tidy operation, a GObject timer was running. Let it continue
running for a few seconds more.
"""
if self.tidy_timer_id:
self.tidy_timer_check_time \
= int(time.time()) + self.tidy_timer_final_time
def tidy_manager_finished(self):
"""Called by self.tidy_timer_callback().
The tidy operation has finished, so update IVs and main window widgets.
"""
# Get the time taken by the tidy operation, so we can convert it into a
# nice string below (e.g. '05:15')
# For some reason, TidyManager.stop_time() might not be set, so we need
# to check for that
if self.tidy_manager_obj.stop_time is not None:
time_num = int(
self.tidy_manager_obj.stop_time \
- self.tidy_manager_obj.start_time
)
else:
time_num = int(time.time() - self.tidy_manager_obj.start_time)
# Any code can check whether an operation is in progress, or not, by
# checking this IV
self.current_manager_obj = None
self.tidy_manager_obj = None
# Stop the timer and reset IVs
GObject.source_remove(self.tidy_timer_id)
self.tidy_timer_id = None
self.tidy_timer_check_time = None
# After a tidy operation, save files, if allowed
if self.operation_save_flag:
self.save_config()
self.save_db()
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
# Remove the progress bar in the Videos tab
self.main_win_obj.hide_progress_bar()
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(True)
# Make the widget changes visible (not necessary if the main window has
# been closed to the system tray)
if self.main_win_obj.is_visible():
self.main_win_obj.show_all()
# The Video Catalogue must be redrawn
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
# Show a dialogue window/desktop notification, if allowed
if self.operation_dialogue_mode != 'default':
if not self.operation_halted_flag:
msg = _('Tidy operation complete')
else:
msg = _('Tidy operation halted')
if time_num >= 10:
msg += '\n\n' + _('Time taken:') + ' ' \
+ utils.convert_seconds_to_string(time_num, True)
if self.operation_dialogue_mode == 'dialogue':
self.dialogue_manager_obj.show_msg_dialogue(msg, 'info', 'ok')
elif self.operation_dialogue_mode == 'desktop':
self.main_win_obj.notify_desktop(None, msg)
# Reset operation IVs
self.operation_halted_flag = False
def livestream_manager_start(self):
"""Can be called by anything.
Initiates a livestream operation to check the status of all media.Video
objects marked as livestreams (everything in self.media_reg_live_dict).
This is one by telling youtube-dl to fetch the video's JSON data.
If a waiting livestream has started, the data is received (otherwise an
error is received).
If a current livestream has finished, the JSON data will say so.
Creates a new downloads.StreamManager object to handle the livestream
operation. When the operation is complete,
self.livestream_manager_finished() is called.
"""
# N.B. Check commented out at the moment, as I think it's unnecessary
# # Check for interrupted database loads
# if self.db_loading_flag:
#
# self.disable_load_save()
# self.system_error(
# 131,
# 'Cannot start the livestream operation because Tartube' \
# + ' failed to finish loading a database (which seems to be' \
# + ' broken)',
# )
#
# return
# Operation already in progress, or a configuration window is open, or
# there are no livestreams to check
# A livestream operation is allowed to start when a download operation
# is already running (but not when any other operation is running)
if (self.current_manager_obj and not self.download_manager_obj) \
or self.livestream_manager_obj \
or self.main_win_obj.config_win_list \
or not self.media_reg_live_dict:
# Don't show a dialogue window as we would for other operations, as
# the livestream operation occurs silently
return
# For the benefit of future scheduled livestream operations, set the
# time at which this operation began
self.scheduled_livestream_last_time = int(time.time())
# Initiate the livestream operation. Any code can check whether an
# operation is in progress, or not, by checking this IV
# (NB Since livestream operations run silently in the background and
# since no functionality is disabled during a livestream operation,
# self.current_manager_obj remains set to None)
self.livestream_manager_obj = downloads.StreamManager(self)
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def livestream_manager_finished(self):
"""Called by downloads.StreamManager.run().
The livestream operation has finished, so update IVs and main window
widgets.
"""
# The operation generated three dictionaries of videos whose livestream
# status has changed
# Before destroying the downloads.StreamManager object, import them
video_started_dict \
= self.livestream_manager_obj.video_started_dict.copy()
video_stopped_dict \
= self.livestream_manager_obj.video_stopped_dict.copy()
video_missing_dict \
= self.livestream_manager_obj.video_missing_dict.copy()
# Any videos marked as missing can be removed from the media registry
# (Note that if a download operation is running, this function won't
# do everything that it would normally do)
if not self.download_manager_obj:
for video_obj in video_missing_dict.values():
# The True argument tells the function to delete files
# associated with the video (the thumbnail, in this case)
self.delete_video(video_obj, True)
# Any code can check whether livestream operation is in progress, or
# not, by checking this IV
self.livestream_manager_obj = None
# Any videos whose livestream status has changed must be redrawn in
# the Video catalogue
# (This function is called from the downloads.StreamManager object, so
# to prevent a crash, its calls must be wrapped in a timer)
if self.main_win_obj.video_index_current \
== self.fixed_live_folder.name:
# Livestreams folder visible; just redraw it
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_redraw_all,
self.fixed_live_folder.name,
)
else:
# (Compile a new dictionary, to eliminate duplicates)
temp_dict = {}
for dbid in video_started_dict:
temp_dict[dbid] = video_started_dict[dbid]
for dbid in video_stopped_dict:
temp_dict[dbid] = video_stopped_dict[dbid]
for this_obj in self.media_reg_live_dict.values():
temp_dict[this_obj.dbid] = this_obj
for video_obj in temp_dict.values():
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
# Notify the user and/or open videos in the system's web browser, if
# a waiting livestream has just gone live (and if allowed to do so)
for video_obj in video_started_dict.values():
if video_obj.dbid in self.media_reg_dict:
# Use the video's thumbnail as the notification icon, if
# available (or None, if not, in which case a generic icon is
# automatically used)
if video_obj.dbid in self.media_reg_auto_notify_dict:
self.main_win_obj.notify_desktop(
_('Livestream has started'),
video_obj.name,
utils.find_thumbnail(self, video_obj),
video_obj.source,
)
if video_obj.dbid in self.media_reg_auto_open_dict \
and video_obj.source:
utils.open_file(self, video_obj.source)
# Play a sound effect (but only one) if any waiting livestream has
# gone live
if video_started_dict:
self.play_sound()
# If the livestream has just started or just stopped, download it (if
# required to do so)
# First compile a dictionary to eliminate duplicate videos
dl_dict = {}
for video_obj in video_started_dict.values():
if video_obj.dbid in self.media_reg_auto_dl_start_dict:
dl_dict[video_obj.dbid] = video_obj
for video_obj in video_stopped_dict.values():
if video_obj.dbid in self.media_reg_auto_dl_stop_dict:
dl_dict[video_obj.dbid] = video_obj
# If the livestream was downloaded when it was still
# broadcasting, then a new download must overwrite the
# original file
# As of April 2020, the youtube-dl --yes-overwrites option is
# still not available, so as a temporary measure we will
# rename the original file (in case the download fails)
self.prepare_overwrite_video(video_obj)
# Then download the videos
if dl_dict:
if not self.download_manager_obj:
# Start a new download operation
self.download_manager_start(
'real',
False,
list(dl_dict.values()),
)
else:
# Download operation already in progress
for video_obj in dl_dict.values():
download_item_obj \
= self.download_manager_obj.download_list_obj.create_item(
video_obj,
None, # media.Scheduled object
'real', # override_operation_type
False, # priority_flag
False, # ignore_limits_flag
)
if download_item_obj:
# Add a row to the Progress List
self.main_win_obj.progress_list_add_row(
download_item_obj.item_id,
video_obj,
)
# Update the main window's progress bar
self.download_manager_obj.nudge_progress_bar()
def process_manager_start(self, options_obj, video_list):
"""Can be called by anything. Currently only called by
config.FFmpegOptionsEditWin.apply_changes().
Initiates a process operation to process video(s) with FFmpeg, using
the options specified by a ffmpeg_tartube.FFmpegOptionsManager object.
Creates a new proces.ProcessManager object to handle the process
operation. When the operation is complete,
self.process_manager_finished() is called.
Args:
options_obj (ffmpeg_tartube.FFmpegOptionsManager): The object
specifying FFmpeg options to apply when processing the video(s)
video_list (list): A listof media.Video objects (should contain at
least one video)
"""
# Check for interrupted database loads
if self.db_loading_flag:
self.disable_load_save()
self.system_error(
132,
'Cannot start the process operation because Tartube failed' \
+ ' to finish loading a database (which seems to be broken)',
)
return
if self.current_manager_obj:
# Operation already in progress
return self.system_error(
133,
'Operation already in progress',
)
elif not video_list:
return self.system_error(
134,
'Process operation requires at least one video',
)
# (Process operations don't modify the media data registry, therefore
# they are allowed to run when a configuration window is open)
# (Process operations should not cause Gtk stability issues)
# During a process operation, show a progress bar in the Videos tab
self.main_win_obj.show_progress_bar('process')
# Reset the Output tab
self.main_win_obj.output_tab_reset_pages()
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(False, True)
# Make the widget changes visible
self.main_win_obj.show_all()
# During a process operation, a GObject timer runs, so that the Output
# tab can be updated at regular intervals
# Create the timer
self.process_timer_id = GObject.timeout_add(
self.process_timer_time,
self.process_timer_callback,
)
# Initiate the process operation. Any code can check whether an
# operation is in progress, or not, by checking this IV
self.current_manager_obj = process.ProcessManager(
self,
options_obj,
video_list,
)
self.process_manager_obj = self.current_manager_obj
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
def process_manager_halt_timer(self):
"""Called by process.ProcessManager.run() when that function has
finished.
During a process operation, a GObject timer was running. Let it
continue running for a few seconds more.
"""
if self.process_timer_id:
self.process_timer_check_time \
= int(time.time()) + self.process_timer_final_time
def process_manager_finished(self):
"""Called by self.process_timer_callback().
The process operation has finished, so update IVs and main window
widgets.
"""
# Get the number of successes and failures
success_count = self.process_manager_obj.success_count
fail_count = self.process_manager_obj.fail_count
new_video_list = self.process_manager_obj.new_video_list
# Get the time taken by the process operation, so we can convert it
# into a nice string below (e.g. '05:15')
# For some reason, ProcessManager.stop_time() might not be set, so we
# need to check for that
if self.process_manager_obj.stop_time is not None:
time_num = int(
self.process_manager_obj.stop_time \
- self.process_manager_obj.start_time
)
else:
time_num = int(time.time() - self.process_manager_obj.start_time)
# Any code can check whether an operation is in progress, or not, by
# checking this IV
self.current_manager_obj = None
self.process_manager_obj = None
# Stop the timer and reset IVs
GObject.source_remove(self.process_timer_id)
self.process_timer_id = None
self.process_timer_check_time = None
# Set the video length and file size for any new media.Video objects
# that have been created (by now, they should all exist on the
# filesystem and be detectable there)
for new_video_obj in new_video_list:
new_video_path = new_video_obj.get_actual_path(self)
if new_video_path and os.path.isfile(new_video_path):
self.update_video_from_filesystem(
new_video_obj,
new_video_path,
)
# After a process operation, save files, if allowed
if self.operation_save_flag:
self.save_config()
self.save_db()
# Update the status icon in the system tray
self.status_icon_obj.update_icon()
# Remove the progress bar in the Videos tab
self.main_win_obj.hide_progress_bar()
# (De)sensitise other widgets, as appropriate
self.main_win_obj.sensitise_operation_widgets(True)
# Make the widget changes visible (not necessary if the main window has
# been closed to the system tray)
if self.main_win_obj.is_visible():
self.main_win_obj.show_all()
# Then show a dialogue window/desktop notification, if allowed
if self.operation_dialogue_mode != 'default':
if not self.operation_halted_flag:
msg = _('Process operation complete')
else:
msg = _('Process operation halted')
if success_count or fail_count:
msg += '\n\n' + _('Files processed:') + ' ' \
+ str(success_count) + '\n' + _('Errors:') + ' ' \
+ str(fail_count)
if time_num >= 10:
msg += '\n\n' + _('Time taken:') + ' ' \
+ utils.convert_seconds_to_string(time_num, True)
if self.operation_dialogue_mode == 'dialogue':
self.dialogue_manager_obj.show_simple_msg_dialogue(
msg,
'info',
'ok',
)
elif self.operation_dialogue_mode == 'desktop':
self.main_win_obj.notify_desktop(None, msg)
# Reset operation IVs
self.operation_halted_flag = False
# (Download operation support functions)
def create_video_from_download(self, download_item_obj, dir_path, \
filename, extension, no_sort_flag=False):
"""Called downloads.VideoDownloader.confirm_new_video(),
.confirm_old_video() and .confirm_sim_video().
When an individual video has been downloaded, this function is called
to create a new media.Video object.
Args:
download_item_obj (downloads.DownloadItem): The object used to
track the download status of a media data object (media.Video,
media.Channel or media.Playlist)
dir_path (str): The full path to the directory in which the video
is saved, e.g. '/home/yourname/tartube/downloads/Videos'
filename (str): The video's filename, e.g. 'My Video'
extension (str): The video's extension, e.g. '.mp4'
no_sort_flag (bool): True when called by
downloads.VideoDownloader.confirm_sim_video(), because the
video's parent containers (including the 'All Videos' folder)
should delay sorting their lists of child objects until that
calling function is ready. False when called by anything else
Returns:
video_obj (media.Video) - The video object created
"""
# The downloads.DownloadItem handles a download for a video, a channel
# or a playlist
media_data_obj = download_item_obj.media_data_obj
if isinstance(media_data_obj, media.Video):
# The downloads.DownloadItem object is handling a single video
video_obj = media_data_obj
else:
# The downloads.DownloadItem object is handling a channel or
# playlist
# Does a media.Video object already exist?
video_obj = None
for child_obj in media_data_obj.child_list:
child_file_dir = None
if child_obj.file_name is not None:
child_file_dir = media_data_obj.get_actual_dir(self)
if isinstance(child_obj, media.Video) \
and child_file_dir \
and child_file_dir == dir_path \
and child_obj.file_name \
and child_obj.file_name == filename:
video_obj = child_obj
if video_obj is None:
# Create a new media data object for the video
options_manager_obj = download_item_obj.options_manager_obj
override_name \
= options_manager_obj.options_dict['use_fixed_folder']
if override_name is not None \
and override_name in self.media_name_dict:
other_dbid = self.media_name_dict[override_name]
other_parent_obj = self.media_reg_dict[other_dbid]
video_obj = self.add_video(
other_parent_obj,
None,
False,
no_sort_flag,
)
else:
video_obj = self.add_video(
media_data_obj,
None,
False,
no_sort_flag,
)
# Update the video name/nickname, if it is not set
if video_obj.name == self.default_video_name:
video_obj.set_name(filename)
video_obj.set_nickname(filename)
# Update the filepath. Even if it is already known, the extension may
# have changed (for example, after checking a video, then downloading
# it)
if video_obj:
video_obj.set_file(filename, extension)
# If the video is marked as a livestream, then the livestream has
# finished
if video_obj.live_mode:
self.mark_video_live(
video_obj,
0, # Not a livestream
{}, # No livestream data
True, # Don't update Video Index yet
True, # Don't update Video Catalogue yet
no_sort_flag,
)
# If the video is in a channel or a playlist, assume that youtube-dl is
# supplying a list of videos in the order of upload, newest first -
# in which case, now is a good time to set the video's .receive_time
# IV
# (If not, the IV is set by media.Video.set_dl_flag when the video is
# actually downloaded)
if isinstance(video_obj.parent_obj, media.Channel) \
or isinstance(video_obj.parent_obj, media.Playlist):
video_obj.set_receive_time()
return video_obj
def convert_video_from_download(self, container_obj, options_manager_obj,
dir_path, filename, extension, no_sort_flag=False):
"""Called downloads.VideoDownloader.confirm_new_video() and
.confirm_sim_video().
A modified version of self.create_video_from_download, called when
youtube-dl is about to download a channel or playlist into a
media.Video object.
Args:
container_obj (media.Folder): The folder into which a replacement
media.Video object is to be created
options_manager_obj (options.OptionsManager): The download options
for this media data object
dir_path (str): The full path to the directory in which the video
is saved, e.g. '/home/yourname/tartube/downloads/Videos'
filename (str): The video's filename, e.g. 'My Video'
extension (str): The video's extension, e.g. '.mp4'
no_sort_flag (bool): True when called by
downloads.VideoDownloader.confirm_sim_video(), because the
video's parent containers (including the 'All Videos' folder)
should delay sorting their lists of child objects until that
calling function is ready. False when called by anything else
Returns:
video_obj (media.Video) - The video object created
"""
# Does the container object already contain this video?
video_obj = None
for child_obj in container_obj.child_list:
child_file_dir = None
if child_obj.file_dir is not None:
child_file_dir = container_obj.get_actual_dir(self)
if isinstance(child_obj, media.Video) \
and child_file_dir \
and child_file_dir == dir_path \
and child_obj.file_name \
and child_obj.file_name == filename:
video_obj = child_obj
if video_obj is None:
# Create a new media data object for the video
override_name \
= options_manager_obj.options_dict['use_fixed_folder']
if override_name is not None \
and override_name in self.media_name_dict:
other_dbid = self.media_name_dict[override_name]
other_container_obj = self.media_reg_dict[other_dbid]
video_obj = self.add_video(
other_container_obj,
None,
False,
no_sort_flag,
)
else:
video_obj = self.add_video(
container_obj,
None,
False,
no_sort_flag,
)
# Since we have them to hand, set the video's file path IVs
# immediately
video_obj.set_file(filename, extension)
return video_obj
def announce_video_download(self, download_item_obj, video_obj, \
mini_options_dict):
"""Called by downloads.VideoDownloader.confirm_new_video(),
.confirm_old_video() and .confirm_sim_video().
Updates the main window.
Args:
download_item_obj (downloads.DownloadItem): The download item
object describing the URL from which youtube-dl should download
video(s).
video_obj (media.Video): The video object for the downloaded video
mini_options_dict (dict): A dictionary containing a subset of
download options from the the options.OptionsManager object
used to download the video. It contains zero, some or all of
the following download options:
keep_description keep_info keep_annotations keep_thumbnail
move_description move_info move_annotations move_thumbnail
"""
# Add the video to the 'Recent Videos' folder, if it's not already
# there. (The code has to go here and not, say, in
# self.create_video_from_download(), because the latter is not
# always called)
if video_obj and not video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.add_child(self, video_obj)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_recent_folder,
)
# If the video's parent media data object (a channel, playlist or
# folder) is selected in the Video Index, update the Video Catalogue
# for the downloaded video
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update the Results List
self.main_win_obj.results_list_add_row(
download_item_obj,
video_obj,
mini_options_dict,
)
def announce_video_clone(self, video_obj):
"""Called by downloads.VideoDownloader.confirm_old_video().
This is a modified version of self.update_video_when_file_found(),
called when a channel/playlist/folder is using an alternative
download destination for its videos (in which case,
self.update_video_when_file_found() can't be called).
Args:
video_obj (media.Video): The video which already exists on the
user's filesystem (in the alternative download destination)
"""
video_path = video_obj.get_actual_path(self)
# Only set the .name IV if the video is currently unnamed
if video_obj.name == self.default_video_name:
video_obj.set_name(video_obj.file_name)
# (The video's title, stored in the .nickname IV, will be updated
# from the JSON data in a moment)
video_obj.set_nickname(video_obj.file_name)
# Set the file size
video_obj.set_file_size(os.path.getsize(video_path))
# If the JSON file was downloaded, we can extract video statistics from
# it
self.update_video_from_json(video_obj)
# For any of those statistics that haven't been set (because the JSON
# file was missing or didn't contain the right statistics), set them
# directly
self.update_video_from_filesystem(video_obj, video_path)
# Mark the video as (fully) downloaded (and update everything else)
self.mark_video_downloaded(video_obj, True)
def create_livestream_from_download(self, container_obj, live_mode,
video_name, video_source, video_descrip, video_upload_time,
live_data_dict={}):
"""Called by downloads.JSONFetcher.do_fetch().
A modified form of self.create_video_from_download(), called at the end
of a download operation when the RSS feed for a channel or playlist is
checked, and contains an unfamiliar video (indicating that it's a
livestream).
Creates a new media.Video object for the livestream.
Args:
containe_obj (media.Channel or media.Playlist): The channel or
playlist in which a livestream has been detected
live_mode (int): Matches media.Video.live_mode: 1 for a waiting
livestream, 2 for a livestream that has started
video_name, video_source, video_descrip (str): Information about
the detected livestream, grabbed from the RSS feed itself
video_upload_time (int): The video's upload time (in Unix time, to
match media.Video.upload_time)
live_data_dict (dict): Dictionary of additional data obtained from
the YouTube STDERR message (empty for a livestream already
broadcasting, or if the message couldn't be interpreted).
Dictionary in the form
live_msg (str): Text that can be displayed in the Video
Catalogue
live_time (int): Approximate time (matching time.time()) at
which the livestream is due to start
live_debut_flag (bool): True for a YouTube 'premiere' video,
False for an ordinary livestream
"""
# Fetch the options.OptionsManager object that applies to the container
options_manager_obj = utils.get_options_manager(self, container_obj)
# Create a new media data object for the video
override_name = options_manager_obj.options_dict['use_fixed_folder']
if override_name is not None and override_name in self.media_name_dict:
other_dbid = self.media_name_dict[override_name]
container_obj = self.media_reg_dict[other_dbid]
video_obj = self.add_video(
container_obj,
video_source,
False, # Not a simulated download
True, # Let the calling function sort the container
)
# Update its IVs
video_obj.set_receive_time()
video_obj.set_name(video_name)
video_obj.set_nickname(video_name)
video_obj.set_video_descrip(
self,
video_descrip,
self.main_win_obj.descrip_line_max_len,
)
video_obj.set_upload_time(video_upload_time)
# Give it a fake filename/extension, so that the Video Catalogue can
# find the thumbnail
# (If a youtube-dl output template is applied, the file that might be
# downloaded later will have a modified name and/or extension)
video_obj.set_file(video_name, '.mp4')
# Mark it as a livestream
self.mark_video_live(video_obj, live_mode, live_data_dict)
# We can now sort the parent containers
video_obj.parent_obj.sort_children(self)
self.fixed_all_folder.sort_children(self)
self.fixed_recent_folder.sort_children(self)
self.fixed_live_folder.sort_children(self)
def update_video_when_file_found(self, video_obj, video_path, temp_dict, \
mkv_flag=False):
"""Called by mainwin.MainWin.results_list_update_row().
When youtube-dl reports it is finished, there is a short delay before
the final downloaded video(s) actually exist in the filesystem.
Once the calling function has confirmed the file exists, it calls this
function to update the media.Video object's IVs.
Args:
video_obj (media.Video): The video object to update
video_path (str): The full filepath to the video file that has been
confirmed to exist
temp_dict (dict): Dictionary of values used to update the video
object, in the form:
'video_obj': not required by this function, as we already have
it
'row_num': not required by this function
'keep_description', 'keep_info', 'keep_annotations',
'keep_thumbnail', 'move_description', 'move_info',
'move_annotations', 'move_thumbnail': flags from the
options.OptionsManager object used for to download the
video ('keep_description', etc, are not not added to the
dictionary at all for simulated downloads)
mkv_flag (bool): If the warning 'Requested formats are incompatible
for merge and will be merged into mkv' has been seen, the
calling function has found an .mkv file rather than the .mp4
file it was expecting, and has set this flag to True
"""
# Only set the .name IV if the video is currently unnamed
if video_obj.name == self.default_video_name:
video_obj.set_name(video_obj.file_name)
# (The video's title, stored in the .nickname IV, will be updated
# from the JSON data in a momemnt)
video_obj.set_nickname(video_obj.file_name)
# If it's an .mkv file because of a failed merge, update the IV
if mkv_flag:
video_obj.set_mkv()
# Set the file size
video_obj.set_file_size(os.path.getsize(video_path))
# If the JSON file was downloaded, we can extract video statistics from
# it
self.update_video_from_json(video_obj)
# For any of those statistics that haven't been set (because the JSON
# file was missing or didn't contain the right statistics), set them
# directly
self.update_video_from_filesystem(video_obj, video_path)
# If FFmpeg is installed, convert .webp thumbnail files to .jpg
thumb_path = utils.find_thumbnail_webp(self, video_obj)
if thumb_path is not None \
and not self.ffmpeg_fail_flag \
and self.ffmpeg_convert_webp_flag \
and not self.ffmpeg_manager_obj.convert_webp(thumb_path):
self.ffmpeg_fail_flag = True
self.system_error(135, self.ffmpeg_fail_msg)
# Discard the description, JSON, annotations and thumbnail files, if
# required to do so. The files are moved to Tartube's temporary
# directory, to be deleted at or before the next startup
# If the files aren't discarded, move them into the sub-directories
# '.thumbs' or '.data', if required
# Description file
if 'keep_description' in temp_dict \
and not temp_dict['keep_description']:
old_path = video_obj.check_actual_path_by_ext(self, '.description')
if old_path is not None:
utils.convert_path_to_temp(
self,
old_path,
True, # Move the file
)
elif 'move_description' in temp_dict \
and temp_dict['move_description']:
utils.move_metadata_to_subdir(self, video_obj, '.description')
# JSON file
if 'keep_info' in temp_dict and not temp_dict['keep_info']:
old_path = video_obj.check_actual_path_by_ext(self, '.info.json')
if old_path is not None:
utils.convert_path_to_temp(
self,
old_path,
True, # Move the file
)
elif 'move_info' in temp_dict and temp_dict['move_info']:
utils.move_metadata_to_subdir(self, video_obj, '.info.json')
# Annotations file
if 'keep_annotations' in temp_dict \
and not temp_dict['keep_annotations']:
old_path = video_obj.check_actual_path_by_ext(
self,
'.annotations.xml',
)
if old_path is not None:
utils.convert_path_to_temp(
self,
old_path,
True, # Move the file
)
elif 'move_annotations' in temp_dict \
and temp_dict['move_annotations']:
utils.move_metadata_to_subdir(self, video_obj, '.annotations.xml')
# Thumbnail
if 'keep_thumbnail' in temp_dict and not temp_dict['keep_thumbnail']:
old_path = utils.find_thumbnail(self, video_obj)
if old_path is not None:
utils.convert_path_to_temp(
self,
old_path,
True, # Move the file
)
elif 'move_thumbnail' in temp_dict and temp_dict['move_thumbnail']:
utils.move_thumbnail_to_subdir(self, video_obj)
# Mark the video as (fully) downloaded (and update everything else)
self.mark_video_downloaded(video_obj, True)
# Register the video's size with the download manager, so that disk
# space limits can be applied, if required
if self.download_manager_obj and video_obj.dl_flag:
self.download_manager_obj.register_video_size(video_obj.file_size)
# If required, launch this video in the system's default media player
if video_obj in self.watch_after_dl_list:
self.watch_after_dl_list.remove(video_obj)
self.watch_video_in_player(video_obj)
self.mark_video_new(video_obj, False)
if video_obj.waiting_flag:
self.mark_video_waiting(video_obj, False)
def update_video_from_json(self, video_obj, mode='default'):
"""Called by self.update_video_when_file_found(),
.announce_video_clone(),
refresh.RefreshManager.refresh_from_default_destination() and
process.ProcessManager.run() and several other functions.
If a video's JSON file exists, extract video statistics from it, and
use them to update the video object.
Args:
video_obj (media.Video): The video object to update
mode (str): 'default' to update everything, 'chapters' to update
only video timestamps, 'comments' to update only comments
"""
json_path = video_obj.check_actual_path_by_ext(self, '.info.json')
if json_path is not None:
json_dict = self.file_manager_obj.load_json(json_path)
if mode == 'default':
if 'title' in json_dict:
video_obj.set_nickname(json_dict['title'])
if 'id' in json_dict:
video_obj.set_vid(json_dict['id'])
# (Git #322, 'upload_date' might be None)
if 'upload_date' in json_dict \
and json_dict['upload_date'] is not None:
try:
# date_string in form YYYYMMDD
date_string = json_dict['upload_date']
dt_obj = datetime.datetime.strptime(
date_string,
'%Y%m%d',
)
video_obj.set_upload_time(dt_obj.timestamp())
except:
video_obj.set_upload_time()
if 'duration' in json_dict:
video_obj.set_duration(json_dict['duration'])
if 'webpage_url' in json_dict:
# !!! DEBUG: yt-dlp Git #119: filter out the extraneous
# characters at the end of the URL, if present
# video_obj.set_source(json_dict['webpage_url'])
video_obj.set_source(
re.sub(
r'\&has_verified\=.*\&bpctr\=.*',
'',
json_dict['webpage_url'],
)
)
if 'description' in json_dict:
video_obj.set_video_descrip(
self,
json_dict['description'],
self.main_win_obj.descrip_line_max_len,
)
if self.store_playlist_id_flag \
and 'playlist_id' in json_dict \
and not isinstance(video_obj.parent_obj, media.Folder):
if 'playlist_title' in json_dict:
video_obj.parent_obj.set_playlist_id(
json_dict['playlist_id'],
json_dict['playlist_title'],
)
else:
video_obj.parent_obj.set_playlist_id(
json_dict['playlist_id'],
None,
)
if 'subtitles' in json_dict and json_dict['subtitles']:
video_obj.extract_subs_list(json_dict['subtitles'])
else:
video_obj.reset_subs_list()
self.extract_parent_name_from_metadata(video_obj, json_dict)
if isinstance(video_obj.parent_obj, media.Channel) \
or isinstance(video_obj.parent_obj, media.Playlist):
# 'Enhanced' websites only: set the channel/playlist RSS
# feed, if not already set
video_obj.parent_obj.update_rss_from_json(json_dict)
# If downloading from a channel/playlist, remember the
# video's index. (The server supplies an index even for a
# channel, and the user might want to convert a channel
# to a playlist)
if 'playlist_index' in json_dict:
video_obj.set_index(json_dict['playlist_index'])
if (
(mode == 'default' and self.comment_store_flag) \
or mode == 'comments'
) and 'comments' in json_dict:
video_obj.set_comments(json_dict['comments'])
if (
(mode == 'default' and self.video_timestamps_extract_json_flag)
or mode == 'chapters'
) and 'chapters' in json_dict \
and (
not video_obj.stamp_list \
or self.video_timestamps_replace_flag
):
video_obj.extract_timestamps_from_chapters(
self,
json_dict['chapters'],
)
if mode == 'default':
if 'is_live' in json_dict \
and json_dict['is_live'] \
and not video_obj.live_mode \
and not video_obj.was_live_flag:
self.mark_video_live(
video_obj,
2,
{},
True, # Don't update Video Index
True, # Don't update Video Catalogue
True, # Don't sort the parent container
)
elif 'was_live' in json_dict \
and json_dict['was_live']:
if video_obj.live_mode:
self.mark_video_live(
video_obj,
0,
{},
True, # Don't update Video Index
True, # Don't update Video Catalogue
True, # Don't sort the parent container
)
elif not video_obj.was_live_flag:
video_obj.set_was_live_flag(True)
def update_video_from_filesystem(self, video_obj, video_path,
override_flag=False):
"""Called by self.update_video_when_file_found(),
.announce_video_clone() and
refresh.RefreshManager.refresh_from_default_destination().
Also called by config.VideoEditWin.on_file_button_clicked().
If a video's JSON file does not exist, or did not contain the
statistics we were looking for, we can set some of them directly from
the filesystem.
Args:
video_obj (media.Video): The video object to update
video_path (str): The full path to the video's file
override_flag (bool): If True, the video's existing statistics are
overwritten, if already set. If False, the video's statistics
are only set if not already defined
"""
if override_flag or video_obj.upload_time is None:
video_obj.set_upload_time(os.path.getmtime(video_path))
if (override_flag or video_obj.duration is None) \
and HAVE_MOVIEPY_FLAG \
and self.use_module_moviepy_flag:
# When the video file is corrupted, moviepy freezes indefinitely
# Instead, let's try placing the procedure inside a thread (unless
# the user has specified a timeout of zero; in which case, don't
# use a thread and let moviepy freeze indefinitely)
if not self.refresh_moviepy_timeout:
clip = moviepy.editor.VideoFileClip(video_path)
video_obj.set_duration(clip.duration)
else:
this_thread = threading.Thread(
target=self.set_duration_from_moviepy,
args=(video_obj, video_path,),
)
this_thread.daemon = True
this_thread.start()
this_thread.join(self.refresh_moviepy_timeout)
if this_thread.is_alive():
self.system_error(
136,
'\'' + video_obj.parent_obj.name \
+ '\': moviepy module failed to fetch duration' \
+ ' of video \'' + video_obj.name + '\'',
)
if override_flag or video_obj.descrip is None:
video_obj.read_video_descrip(
self,
self.main_win_obj.descrip_line_max_len,
)
if override_flag or video_obj.file_size is None:
try:
video_obj.set_file_size(os.path.getsize(video_path))
except:
self.system_error(
137,
'\'' + video_obj.parent_obj.name \
+ '\': failed to set file size of video \'' \
+ video_obj.name + '\'',
)
def set_duration_from_moviepy(self, video_obj, video_path):
"""Called by self.update_video_from_filesystem().
When we call moviepy.editor.VideoFileClip() on a corrupted video file,
moviepy freezes indefinitely.
This function is called inside a thread, so a timeout of (by default)
ten seconds can be applied.
Args:
video_obj (media.Video): The video object being updated
video_path (str): The path to the video file itself
"""
try:
clip = moviepy.editor.VideoFileClip(video_path)
video_obj.set_duration(clip.duration)
except:
self.system_error(
138,
'\'' + video_obj.parent_obj.name + '\': moviepy module' \
+ ' failed to fetch duration of video \'' \
+ video_obj.name + '\'',
)
def prepare_overwrite_video(self, video_obj):
"""Called by self.livestream_manager_finished() and
mainwin.MainWin.on_click_watch_player_label().
If the specified video is a livestream that was downloaded when it was
still broadcasting, then a new download must overwrite the original
file.
As of April 2020, the youtube-dl --yes-overwrites option is still not
available, so as a temporary measure we will rename the original file
(in case the download fails).
Args:
video_obj (media.Video): The video which this function assumes is
(or was) a livestream
"""
path = os.path.abspath(
os.path.join(
video_obj.parent_obj.get_actual_dir(self),
video_obj.file_name + video_obj.file_ext,
),
)
bu_path = path + '_BU'
if os.path.isfile(path):
utils.rename_file(self, path, bu_path)
def extract_parent_name_from_metadata(self, video_obj, json_dict):
"""Called by self.update_video_from_json() and
downloads.VideoDownloader.confirm_sim_video().
self.media_reset_container_dict contains a collection of channels/
playlists whose names in Tartube's database don't match the names
extracted from a video's metadata.
Add a new key-value pair to the list, if required.
Args:
video_obj (media.Video): The video which has just been checked/
downloaded
json_dict (dict): JSON metadata for that video
"""
# For a typical YouTube video, both fields will exist
# For a typical YouTube playlist, the .channel field will be something
# like 'REAL_NAME - videos'
if 'channel' in json_dict:
channel_name = json_dict['channel']
else:
channel_name = None
if 'playlist_title' in json_dict:
playlist_name = json_dict['playlist_title']
else:
playlist_name = None
# The IV only keeps track of channels/playlists
# The IV only keeps track of the first channel/playlist name
# extracted from a child video
# THe IV only keeps track of channels/playlists whose names are not the
# same as those used in Tartube's database
if not isinstance(video_obj.parent_obj, media.Folder) \
and not video_obj.parent_obj.dbid in self.media_reset_container_dict:
if isinstance(video_obj.parent_obj, media.Channel) \
and channel_name is not None \
and channel_name != '':
self.media_reset_container_dict[video_obj.parent_obj.dbid] \
= channel_name
elif isinstance(video_obj.parent_obj, media.Playlist) \
and playlist_name is not None \
and playlist_name != '':
self.media_reset_container_dict[video_obj.parent_obj.dbid] \
= playlist_name
# (Add media data objects)
def add_video(self, parent_obj, source=None, dl_sim_flag=False,
no_sort_flag=False):
"""Can be called by anything.
Creates a new media.Video object, and updates IVs.
Args:
parent_obj (media.Channel, media.Playlist or media.Folder): The
media data object for which the new media.Video object is the
child (all videos have a parent)
source (str): The video's source URL, if known
dl_sim_flag (bool): If True, the video object's .dl_sim_flag IV is
set to True, which forces simulated downloads
no_sort_flag (bool): True when
self.create_video_from_download() is called by
downloads.VideoDownloader.confirm_sim_video(), because the
video's parent containers (including the 'All Videos' folder)
should delay sorting their lists of child objects until that
calling function is ready. False when called by anything else
Returns:
The new media.Video object
"""
# Videos can't be placed inside other videos
if parent_obj and isinstance(parent_obj, media.Video):
return self.system_error(
139,
'Videos cannot be placed inside other videos',
)
# Videos can't be added directly to a private folder
elif parent_obj and isinstance(parent_obj, media.Folder) \
and parent_obj.priv_flag:
return self.system_error(
140,
'Videos cannot be placed inside a private folder',
)
# Create a new media.Video object
video_obj = media.Video(
self,
self.media_reg_count,
self.default_video_name,
parent_obj,
None, # Use default download options
no_sort_flag,
)
if source is not None:
video_obj.set_source(source)
if dl_sim_flag:
video_obj.set_dl_sim_flag(True)
# Update IVs
self.media_reg_count += 1
self.media_reg_dict[video_obj.dbid] = video_obj
# The private 'All Videos' folder also has this video as a child object
self.fixed_all_folder.add_child(self, video_obj, no_sort_flag)
# Update the row in the Video Index for both the parent and private
# folder
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
video_obj.parent_obj,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_all_folder,
)
# If the video's parent is the one visible in the Video Catalogue (or
# if 'Unsorted Videos' or 'Temporary Videos', etc, is the one visible
# in the Video Catalogue), the new video itself won't be visible
# there yet
# Make sure the video is visible, if appropriate
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
return video_obj
def add_channel(self, name, parent_obj=None, source=None, \
dl_sim_flag=None):
"""Can be called by anything.
Creates a new media.Channel object, and updates IVs.
Args:
name (str): The channel name
parent_obj (media.Folder): The media data object for which the new
media.Channel object is a child (if any)
source (str): The channel's source URL, if known
dl_sim_flag (bool): True if we should simulate downloads for videos
in this channel, False if we should actually download them
(when allowed)
Returns:
The new media.Channel object
"""
# Channels can only be placed inside an unrestricted media.Folder
# object (if they have a parent at all)
if parent_obj \
and (
not isinstance(parent_obj, media.Folder) \
or parent_obj.restrict_mode != 'open'
):
return self.system_error(
141,
'Channels cannot be added to a restricted folder',
)
# There is a limit to the number of levels allowed in the media
# registry
if parent_obj and parent_obj.get_depth() >= self.media_max_level:
return self.system_error(
142,
'Channel exceeds maximum depth of media registry',
)
# Some names are not allowed at all
if name is None \
or re.search('^\s*$', name) \
or not self.check_container_name_is_legal(name):
return self.system_error(
143,
'Illegal channel name',
)
# Create a new media.Channel object
channel_obj = media.Channel(
self,
self.media_reg_count,
name,
parent_obj,
None, # Use default download options
)
if source is not None:
channel_obj.set_source(source)
if dl_sim_flag is not None:
channel_obj.set_dl_sim_flag(dl_sim_flag)
# Update IVs
self.media_reg_count += 1
self.media_reg_dict[channel_obj.dbid] = channel_obj
self.media_name_dict[channel_obj.name] = channel_obj.dbid
if not parent_obj:
self.media_top_level_list.append(channel_obj.dbid)
# Create the directory used by this channel (if it doesn't already
# exist)
dir_path = channel_obj.get_default_dir(self)
if not os.path.exists(dir_path):
self.make_directory(dir_path)
return channel_obj
def add_playlist(self, name, parent_obj=None, source=None, \
dl_sim_flag=None):
"""Can be called by anything.
Creates a new media.Playlist object, and updates IVs.
Args:
name (str): The playlist name
parent_obj (media.Folder): The media data object for which the new
media.Playlist object is a child (if any)
source (str): The playlist's source URL, if known
dl_sim_flag (bool): True if we should simulate downloads for videos
in this playlist, False if we should actually download them
(when allowed)
Returns:
The new media.Playlist object
"""
# Playlists can only be place inside an unrestricted media.Folder
# object (if they have a parent at all)
if parent_obj \
and (
not isinstance(parent_obj, media.Folder) \
or parent_obj.restrict_mode != 'open'
):
return self.system_error(
144,
'Playlists cannot be added to a restricted folder',
)
# There is a limit to the number of levels allowed in the media
# registry
if parent_obj and parent_obj.get_depth() >= self.media_max_level:
return self.system_error(
145,
'Playlist exceeds maximum depth of media registry',
)
# Some names are not allowed at all
if name is None \
or re.search('^\s*$', name) \
or not self.check_container_name_is_legal(name):
return self.system_error(
146,
'Illegal playlist name',
)
# Create a new media.Playlist object
playlist_obj = media.Playlist(
self,
self.media_reg_count,
name,
parent_obj,
None, # Use default download options
)
if source is not None:
playlist_obj.set_source(source)
if dl_sim_flag is not None:
playlist_obj.set_dl_sim_flag(dl_sim_flag)
# Update IVs
self.media_reg_count += 1
self.media_reg_dict[playlist_obj.dbid] = playlist_obj
self.media_name_dict[playlist_obj.name] = playlist_obj.dbid
if not parent_obj:
self.media_top_level_list.append(playlist_obj.dbid)
# Create the directory used by this playlist (if it doesn't already
# exist)
dir_path = playlist_obj.get_default_dir(self)
if not os.path.exists(dir_path):
self.make_directory(dir_path)
# Procedure complete
return playlist_obj
def add_folder(self, name, parent_obj=None, dl_sim_flag=False,
restrict_mode='open', fixed_flag=False, priv_flag=False, temp_flag=False):
"""Can be called by anything.
Creates a new media.Folder object, and updates IVs.
Args:
name (str): The folder name
parent_obj (media.Folder): The media data object for which the new
media.Channel object is a child (if any)
dl_sim_flag (bool): If True, the folders .dl_sim_flag IV is set to
True, which forces simulated downloads for any videos,
channels or playlists contained in the folder
restrict_mode (str): 'full' if this folder can contain videos, but
not channels/playlists/folders, 'partial' if this folder can
contain videos and folders, but not channels and playlists,
'open' if this folder can contain any combination of videos,
channels, playlists and folders
fixed_flag, priv_flag, temp_flag (bool): Flags sent to the object's
.__init__() function
Returns:
The new media.Folder object
"""
# Folders can only be placed inside an unrestricted media.Folder object
# (if they have a parent at all)
if parent_obj \
and (
not isinstance(parent_obj, media.Folder) \
or parent_obj.restrict_mode == 'full'
):
return self.system_error(
147,
'Folders cannot be added to another restricted folder',
)
# There is a limit to the number of levels allowed in the media
# registry
if parent_obj and parent_obj.get_depth() >= self.media_max_level:
return self.system_error(
148,
'Folder exceeds maximum depth of media registry',
)
# Some names are not allowed at all
if name is None \
or re.search('^\s*$', name) \
or not self.check_container_name_is_legal(name):
return self.system_error(
149,
'Illegal folder name',
)
folder_obj = media.Folder(
self,
self.media_reg_count,
name,
parent_obj,
None, # Use default download options
restrict_mode,
fixed_flag,
priv_flag,
temp_flag,
)
if dl_sim_flag:
folder_obj.set_dl_sim_flag(True)
# Update IVs
self.media_reg_count += 1
self.media_reg_dict[folder_obj.dbid] = folder_obj
self.media_name_dict[folder_obj.name] = folder_obj.dbid
if not parent_obj:
self.media_top_level_list.append(folder_obj.dbid)
# Create the directory used by this folder (if it doesn't already
# exist)
# Obviously don't do that for private folders
dir_path = folder_obj.get_default_dir(self)
if not folder_obj.priv_flag and not os.path.exists(dir_path):
self.make_directory(dir_path)
# Procedure complete
return folder_obj
# (Move media data objects)
def move_container_to_top(self, media_data_obj):
"""Called by mainwin.MainWin.on_video_index_move_to_top().
Before moving a channel, playlist or folder, get confirmation from the
user.
After getting confirmation, call self.move_container_to_top_continue()
to move the channel, playlist or folder to the top level (in other
words, removes its parent folder).
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder): The
moving media data object
"""
# Do some basic checks
if media_data_obj is None or isinstance(media_data_obj, media.Video) \
or self.current_manager_obj or not media_data_obj.parent_obj:
return self.system_error(
150,
'Move container to top request failed sanity check',
)
# Check that the target directory doesn't already exist (unlikely, but
# possible if the user has been copying files manually)
target_path = os.path.abspath(
os.path.join(
self.downloads_dir,
media_data_obj.name,
),
)
if os.path.isdir(target_path) or os.path.isfile(target_path):
# (The same error message appears in self.move_container() )
self.dialogue_manager_obj.show_msg_dialogue(
_('Cannot move anything to:') + '\n\n' + target_path + '\n\n' \
+ _(
'because a file or folder with the same name already' \
+ ' exists (although Tartube\'s database doesn\'t know' \
+ ' anything about it)',
) + '\n\n' + _(
'You probably created that file/folder accidentally,' \
+ ' in which case you should delete it manually before' \
+ ' trying again',
),
'error',
'ok',
)
return
# Prompt the user for confirmation. If the user clicks 'yes', call
# self.move_container_to_top_continue() to complete the move
media_type = media_data_obj.get_type()
if media_type == 'channel':
msg = _('Are you sure you want to move this channel:')
elif media_type == 'playlist':
msg = _('Are you sure you want to move this playlist:')
else:
msg = _('Are you sure you want to move this folder:')
msg += '\n\n ' + media_data_obj.name + '\n\n'
msg += _(
'This procedure will move all downloaded files to the top' \
+ ' level of Tartube\'s data folder',
)
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .move_container_to_top_continue()
{
'yes': 'move_container_to_top_continue',
'data': media_data_obj,
},
)
def move_container_to_top_continue(self, media_data_obj):
"""Called by self.move_container_to_top().
Moves a channel, playlist or folder to the top level (in other words,
removes its parent folder).
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder): The
moving media data object
"""
# Move the sub-directories to their new location
if not self.move_file_or_directory(
media_data_obj.get_default_dir(self),
self.downloads_dir,
):
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Could not move \'{0}\' (filesystem error)'
).format(media_data_obj.name),
'error',
'ok',
)
return
# Update IVs
media_data_obj.parent_obj.del_child(media_data_obj)
media_data_obj.set_parent_obj(None)
self.media_top_level_list.append(media_data_obj.dbid)
# Save the database (because, if the user terminates Tartube and then
# restarts it, then tries to perform a download operation, a load of
# Python error messages will be generated, complaining that
# directories don't exist)
self.save_db()
# Redraw the whole Video Index, which makes sure the moved container
# has an expanding arrow button
self.main_win_obj.video_index_reset()
self.main_win_obj.video_index_populate()
# Select the moving object, which redraws the Video Catalogue
self.main_win_obj.video_index_select_row(media_data_obj)
def move_container(self, source_obj, dest_obj):
"""Called by mainwin.MainWin.on_video_index_drag_data_received().
Before moving a channel, playlist or folder, get confirmation from the
user.
After getting confirmation, call self.move_container_continue() to move
the channel, playlist or folder into another folder.
Args:
source_obj (media.Channel, media.Playlist, media.Folder): The
moving media data object
dest_obj (media.Folder): The destination folder
"""
# Do some basic checks
if source_obj is None or isinstance(source_obj, media.Video) \
or dest_obj is None or isinstance(dest_obj, media.Video):
return self.system_error(
151,
'Move container request failed sanity check',
)
elif source_obj == dest_obj or source_obj.parent_obj == dest_obj:
# No need for a system error message if the user drags a folder
# onto itself, or onto its own parent; just do nothing
return
# Ignore Video Index drag-and-drop during an operation
elif self.current_manager_obj:
return
elif not isinstance(dest_obj, media.Folder):
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Channels, playlists and folders can only be dragged into' \
+ ' a folder',
),
'error',
'ok',
)
return
elif isinstance(source_obj, media.Folder) and source_obj.fixed_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'The fixed folder \'{0}\' cannot be moved (but it can still' \
+ ' be hidden)',
).format(dest_obj.name),
'error',
'ok',
)
return
elif dest_obj.restrict_mode == 'full':
self.dialogue_manager_obj.show_msg_dialogue(
_(
'The folder \'{0}\' can only contain videos',
).format(dest_obj.name),
'error',
'ok',
)
return
elif dest_obj.restrict_mode == 'partial':
self.dialogue_manager_obj.show_msg_dialogue(
_(
'The folder \'{0}\' can only contain other folders and videos',
).format(dest_obj.name),
'error',
'ok',
)
return
# Check that the target directory doesn't already exist (unlikely, but
# possible if the user has been copying files manually)
target_path = os.path.abspath(
os.path.join(
dest_obj.get_default_dir(self),
source_obj.name,
),
)
if os.path.isdir(target_path) or os.path.isfile(target_path):
self.dialogue_manager_obj.show_msg_dialogue(
_('Cannot move anything to:') + '\n\n' + target_path + '\n\n' \
+ _(
'because a file or folder with the same name already exists' \
+ ' (although Tartube\'s database doesn\'t know anything' \
+ ' about it)',
) + '\n\n' \
+ _(
'You probably created that file/folder accidentally, in' \
+ ' which case, you should delete it manually before trying' \
+ ' again',
),
'error',
'ok',
)
return
# Prompt the user for confirmation
source_type = source_obj.get_type()
if source_type == 'channel':
msg = _('Are you sure you want to move this channel:')
elif source_type == 'playlist':
msg = _('Are you sure you want to move this playlist:')
else:
msg = _('Are you sure you want to move this folder:')
msg += '\n\n ' + source_obj.name + '\n\n' + _('into this folder:') \
+ '\n\n ' + dest_obj.name + '\n\n'
msg += _(
'This procedure will move all downloaded files to the new' \
+ ' location',
)
if dest_obj.temp_flag:
msg += '\n\n' + _(
'WARNING: The destination folder is marked as temporary, so' \
+ ' everything inside it will be DELETED when Tartube' \
+ ' restarts!',
)
# If the user clicks 'yes', call self.move_container_continue() to
# complete the move
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .move_container_continue()
{
'yes': 'move_container_continue',
'data': [source_obj, dest_obj],
},
)
def move_container_continue(self, media_list):
"""Called by self.move_container().
Moves a channel, playlist or folder into another folder.
Args:
media_list (list): List in the form (destination, source), where
both are media.Folder objects
"""
source_obj = media_list[0]
dest_obj = media_list[1]
# Move the sub-directories to their new location
if not self.move_file_or_directory(
source_obj.get_default_dir(self),
dest_obj.get_default_dir(self),
):
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Could not move \'{0}\' (filesystem error)'
).format(media_data_obj.name),
'error',
'ok',
)
return
# Update both media data objects' IVs
if source_obj.parent_obj:
source_obj.parent_obj.del_child(source_obj)
dest_obj.add_child(self, source_obj)
source_obj.set_parent_obj(dest_obj)
if source_obj.dbid in self.media_top_level_list:
index = self.media_top_level_list.index(source_obj.dbid)
del self.media_top_level_list[index]
# Save the database (because, if the user terminates Tartube and then
# restarts it, then tries to perform a download operation, a load of
# Python error messages will be generated, complaining that
# directories don't exist)
self.save_db()
# Redraw the whole Video Index, which makes sure the moved container
# has an expanding arrow button
self.main_win_obj.video_index_reset()
self.main_win_obj.video_index_populate()
# Select the moving object, which redraws the Video Catalogue
self.main_win_obj.video_index_select_row(source_obj)
def move_videos(self, dest_obj, video_list):
"""Called by mainwin.MainWin.on_video_index_drag_data_received().
Moves one or more videos to a new parent container.
Args:
dest_obj (media.Channel, media.Playlist, media.Folder): The
destination container
video_list (list): List of media.Video objects to move into the
destination container
"""
if isinstance(dest_obj, media.Video) or not video_list:
return self.system_error(
152,
'Move videos request failed sanity check',
)
for video_obj in video_list:
if not isinstance(video_obj, media.Video):
return self.system_error(
153,
'Move videos request failed sanity check',
)
# Videos cannot be dragged into most fixed folders
if isinstance(dest_obj, media.Folder) \
and dest_obj.priv_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_('Videos cannot be dragged into this folder'),
'error',
'ok',
)
return
# Prompt the user for confirmation
if len(video_list) == 1:
msg = _(
'Are you sure you want to move the video to \'{0}\'?',
).format(dest_obj.name)
else:
msg = _(
'Are you sure you want to move \'{0}\' videos to \'{1}\'?',
).format(len(video_list), dest_obj.name)
if isinstance(dest_obj, media.Folder) \
and dest_obj.temp_flag:
msg += '\n\n' + _(
'WARNING: The destination folder is marked as temporary, so' \
+ ' everything inside it will be DELETED when Tartube' \
+ ' restarts!',
)
# If the user clicks 'yes', call self.move_videos_continue() to
# complete the move
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .move_videos_continue()
{
'yes': 'move_videos_continue',
'data': [dest_obj, video_list],
},
)
def move_videos_continue(self, media_list):
"""Called by self.move_videos().
Moves a list of videos to a new channel, playlist or folder.
Args:
media_list (list): List in the form (destination, video_list),
where the 'destination' is a media.Channel, media.Playlist or
media.Folder object, and 'video_list' is a list of media.Video
objects
"""
dest_obj = media_list[0]
video_list = media_list[1]
# Get the destination directory. If the channel/playlist/folder is
# set up to use another channel/playlist/folder's directory,
# then ignore that: use its default directory
# Exception: do use an external directory, if it is set
if dest_obj.external_dir:
dest_dir = dest_obj.external_dir
else:
dest_dir = dest_obj.get_default_dir(self)
# Move videos and their associated files, one at a time
success_count = 0
fail_count = 0
already_count = 0
for video_obj in video_list:
if video_obj.file_name is None:
# No video file to move
fail_count += 1
continue
if video_obj.parent_obj == dest_obj:
# Video is already here
already_count += 1
continue
# Move the video file (if it has been downloaded)
if video_obj.dl_flag:
old_path = video_obj.get_actual_path(self)
new_path = os.path.abspath(
os.path.join(
dest_dir,
video_obj.file_name + video_obj.file_ext,
),
)
if not os.path.isfile(old_path) \
or os.path.isfile(new_path):
# Don't move a non-existent file, or overwrite an existing
# file
fail_count += 1
continue
if not self.move_file_or_directory(old_path, new_path):
fail_count += 1
continue
# Move the metadata files
for file_ext in ('.description', '.info.json', '.annotations.xml'):
old_path = video_obj.check_actual_path_by_ext(self, file_ext)
if old_path is not None:
new_path = os.path.abspath(
os.path.join(
dest_dir,
video_obj.file_name + file_ext,
),
)
if os.path.isfile(old_path) \
and not os.path.isfile(new_path):
self.move_file_or_directory(old_path, new_path)
# Move the thumbnail
old_path = utils.find_thumbnail(self, video_obj)
if old_path is not None:
ignore, thumb_file = os.path.split(old_path)
new_path = os.path.abspath(
os.path.join(dest_dir, thumb_file),
)
if os.path.isfile(old_path) and not os.path.isfile(new_path):
self.move_file_or_directory(old_path, new_path)
# Update IVs in the old and new parent containers
video_obj.parent_obj.del_child(video_obj)
# (The True argument instructs the container to delay sorting its
# children)
dest_obj.add_child(self, video_obj, True)
# Update the video
video_obj.set_parent_obj(dest_obj)
success_count += 1
# All done. Tell the destination to sort its children
dest_obj.sort_children(self)
# Redraw the Video Index (the videos may have come from multiple
# locations, so it's simpler just to redraw the whole thing)
if success_count:
self.main_win_obj.video_index_reset()
self.main_win_obj.video_index_populate()
# Open the destination, which redraws the Video Catalogue
self.main_win_obj.video_index_select_row(dest_obj)
# Show confirmation dialogue
msg = _('Videos moved') + ': ' + str(success_count) \
+ '\n' + _('Videos not moved:') + ': ' \
+ str(fail_count + already_count)
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'info',
'ok',
)
# (Convert channels to playlists, and vice-versa)
def convert_remote_container(self, old_obj):
"""Called by mainwin.MainWin.on_video_index_convert_container().
Converts a media.Channel object into a media.Playlist object, or vice-
versa.
Usually called after the user has copy-pasted a list of URLs into the
mainwin.AddVideoDialogue window, some of which actually represent
channels or playlists, not individual videos. During the next
download operation, new channels or playlists can be automatically
created (depending on the value of self.operation_convert_mode
The user can then convert a channel to a playlist, and back again, as
required.
Args:
old_obj (media.Channel, media.Playlist): The media data object to
convert
"""
if (
not isinstance(old_obj, media.Channel) \
and not isinstance(old_obj, media.Playlist)
) or self.current_manager_obj:
return self.system_error(
154,
'Convert container request failed sanity check',
)
# If old_obj is a media.Channel, create a playlist. If old_obj is
# a media.Playlist, create a channel
if isinstance(old_obj, media.Channel):
new_obj = self.add_playlist(
old_obj.name,
old_obj.parent_obj,
old_obj.source,
old_obj.dl_sim_flag,
)
elif isinstance(old_obj, media.Playlist):
new_obj = self.add_channel(
old_obj.name,
old_obj.parent_obj,
old_obj.source,
old_obj.dl_sim_flag,
)
# Move any children from the old object to the new one
for child_obj in old_obj.child_list:
# The True argument means to delay sorting the child list
new_obj.add_child(self, child_obj, True)
child_obj.set_parent_obj(new_obj)
# Deal with alternative download destinations
if old_obj.master_dbid:
new_obj.set_master_dbid(self, old_obj.master_dbid)
master_obj = self.media_reg_dict[old_obj.master_dbid]
master_obj.del_slave_dbid(old_obj.dbid)
for slave_dbid in old_obj.slave_dbid_list:
slave_obj = self.media_reg_dict[slave_dbid]
slave_obj.set_master_dbid(self, new_obj.dbid)
# Copy remaining properties from the old object to the new one
new_obj.clone_properties(old_obj)
# Remove the old object from the media data registry.
# self.media_name_dict should already be updated
del self.media_reg_dict[old_obj.dbid]
if old_obj.dbid in self.media_top_level_list:
self.media_top_level_list.remove(old_obj.dbid)
# Remove the old object from the Video Index...
self.main_win_obj.video_index_delete_row(old_obj)
# ...and add the new one, selecting it at the same time
self.main_win_obj.video_index_add_row(new_obj)
# (Delete media data objects)
def delete_video(self, video_obj, delete_files_flag=False,
no_update_index_flag=False, no_update_catalogue_flag=False):
"""Can be called by anything.
Deletes a video object from the media registry.
Args:
video_obj (media.Video): The media.Video object to delete
delete_files_flag (bool): True when called by
mainwin.MainWin.on_video_catalogue_delete_video, in which case
the video and its associated files are deleted from the
filesystem
no_update_index_flag (bool): True when called by
self.delete_old_videos() or self.delete_container(), in which
case the Video Index is not updated
no_update_catalogue_flag (bool): True when called by
self.delete_old_videos(), in which case the Video Catalogue is
not updated
"""
if not isinstance(video_obj, media.Video):
return self.system_error(
155,
'Delete video request failed sanity check',
)
# Destroy the options.OptionsManager object attached to this video
# (if any), unless it's also the one used in the Classic Mode tab
if video_obj.options_obj:
if (
not self.classic_options_obj \
or self.classic_options_obj != video_obj.options_obj
):
del self.options_reg_dict[video_obj.options_obj.uid]
else:
# This is the options.OptionsManager used in the Classic Mode
# tab (an unlikely situation, but possible)
self.classic_options_obj.reset_dbid()
# Update the list in any preference windows that are open
for win_obj in self.main_win_obj.config_win_list:
if isinstance(win_obj, config.SystemPrefWin):
win_obj.setup_options_dl_list_tab_update_treeview()
# Remove the video from its parent object
video_obj.parent_obj.del_child(video_obj)
# Remove the corresponding entry in each private folder's child list
update_list = [video_obj.parent_obj]
if self.fixed_all_folder.del_child(video_obj):
update_list.append(self.fixed_all_folder)
if self.fixed_bookmark_folder.del_child(video_obj):
update_list.append(self.fixed_bookmark_folder)
if self.fixed_fav_folder.del_child(video_obj):
update_list.append(self.fixed_fav_folder)
if self.fixed_live_folder.del_child(video_obj):
update_list.append(self.fixed_live_folder)
if self.fixed_missing_folder.del_child(video_obj):
update_list.append(self.fixed_missing_folder)
if self.fixed_new_folder.del_child(video_obj):
update_list.append(self.fixed_new_folder)
if self.fixed_recent_folder.del_child(video_obj):
update_list.append(self.fixed_recent_folder)
if self.fixed_waiting_folder.del_child(video_obj):
update_list.append(self.fixed_waiting_folder)
# Remove the video from our IVs
# v1.2.017 When deleting folders containing thousands of videos, I
# noticed that a small number of video DBIDs didn't exist in the
# media data registry. Not sure what the cause is, but the following
# lines prevent a python error
if video_obj.dbid in self.media_reg_dict:
del self.media_reg_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_live_dict:
del self.media_reg_live_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_notify_dict:
del self.media_reg_auto_notify_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_alarm_dict:
del self.media_reg_auto_alarm_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_open_dict:
del self.media_reg_auto_open_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_dl_start_dict:
del self.media_reg_auto_dl_start_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_dl_stop_dict:
del self.media_reg_auto_dl_stop_dict[video_obj.dbid]
# Delete files from the filesystem, if required
# If the parent container has an alternative download destination set,
# the files are in the corresponding directory. We don't delete the
# files because another channel/playlist/folder might be using them
if delete_files_flag \
and video_obj.file_name \
and video_obj.parent_obj.dbid == video_obj.parent_obj.master_dbid:
self.delete_video_files(video_obj)
# Remove the video from the catalogue, if present
if not no_update_catalogue_flag:
self.main_win_obj.video_catalogue_delete_video(video_obj)
# Update rows in the Video Index, first checking that the parent
# container object is currently drawn there (which it might not be,
# if emptying temporary folders on startup)
if not no_update_index_flag:
for container_obj in update_list:
if container_obj.name \
in self.main_win_obj.video_index_row_dict:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
# Update a row in the Results List, if the video is visible there
self.main_win_obj.results_list_update_row_on_delete(video_obj.dbid)
def delete_video_files(self, video_obj):
"""Called by self.delete_video(), .on_button_classic_redownload() and
mainwin.MainWin.on_video_catalogue_re_download().
Deletes the files associated with a media.Video object, including not
just the original video/audio file, but its metadata files too.
Args:
video_obj (media.Video): The media.Video object whose files should
be deleted
"""
# Sanity check
if video_obj.file_name is None and not video_obj.dummy_flag:
return
# There might be thousands of files in the directory, so using
# os.walk() or something like that might be too expensive
# Also, post-processing might create various artefacts, all of which
# must be deleted
ext_list = [
'description',
'info.json',
'annotations.xml',
]
ext_list.extend(formats.VIDEO_FORMAT_LIST)
ext_list.extend(formats.AUDIO_FORMAT_LIST)
for ext in ext_list:
if video_obj.dummy_flag:
if video_obj.dummy_path is None:
# Nothing to delete
continue
else:
dummy_file, dummy_ext \
= os.path.splitext(video_obj.dummy_path)
main_path = dummy_file + '.' + ext
if os.path.isfile(main_path):
self.remove_file(main_path)
else:
main_path = video_obj.get_default_path_by_ext(self, ext)
if os.path.isfile(main_path):
self.remove_file(main_path)
else:
subdir_path \
= video_obj.get_default_path_in_subdirectory_by_ext(
self,
ext,
)
if os.path.isfile(subdir_path):
self.remove_file(subdir_path)
# (Thumbnails might be in one of two locations, so are handled
# separately)
thumb_path = utils.find_thumbnail(self, video_obj)
if thumb_path and os.path.isfile(thumb_path):
self.remove_file(thumb_path)
def delete_container(self, media_data_obj, empty_flag=False):
"""Can be called by anything.
Before deleting a channel, playlist or folder object from the media
data registry, get confirmation from the user.
The process is split across three functions.
This functions obtains confirmation from the user. If deleting files,
a second confirmation is required, and self.delete_container_continue()
is called in response.
In either case, self.delete_container_complete() is then called to
update the media data registry.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder):
The container media data object
empty_flag (bool): If True, the container media data object is to
be emptied, rather than being deleted
"""
# Check this isn't a video or a fixed folder (which cannot be removed)
# v2.1.029 In some older databases, a fixed folder called 'downloads_2'
# was created, containing a small number of videos. I'm still not
# sure under which circumstances that folder was created; in any
# case, such a folder needs to be deleteable
if isinstance(media_data_obj, media.Video) \
or (
isinstance(media_data_obj, media.Folder)
and media_data_obj.fixed_flag
and self.check_fixed_folder(media_data_obj)
):
return self.system_error(
156,
'Delete container request failed sanity check',
)
# Prompt the user for confirmation, even if the container object has no
# children
# (Even though there are no children, we can't guarantee that the
# sub-directories in Tartube's data directory are empty)
# Exceptions: don't prompt for confirmation if media_data_obj is
# somewhere inside a temporary folder, or if the user has disabled
# these dialogue windows)
confirm_flag = self.show_delete_container_dialogue_flag
delete_file_flag = False
parent_obj = media_data_obj.parent_obj
while parent_obj is not None:
if isinstance(parent_obj, media.Folder) and parent_obj.temp_flag:
# The media data object is somewhere inside a temporary folder;
# no need to prompt for confirmation
confirm_flag = False
parent_obj = parent_obj.parent_obj
if confirm_flag:
# Prompt the user for confirmation
dialogue_win = mainwin.DeleteContainerDialogue(
self.main_win_obj,
media_data_obj,
empty_flag,
)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
if dialogue_win.button2.get_active():
delete_file_flag = True
else:
delete_file_flag = False
if dialogue_win.button3.get_active():
show_win_flag = True
else:
show_win_flag = False
# ...before destroying it
dialogue_win.destroy()
if response != Gtk.ResponseType.OK:
return
# Update IVs
self.delete_container_files_flag = delete_file_flag
self.show_delete_container_dialogue_flag = show_win_flag
# Get a second confirmation
if delete_file_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Are you SURE you want to delete files? This procedure' \
' cannot be reversed!',
),
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .delete_container_continue()
{
'yes': 'delete_container_continue',
'data': [media_data_obj, empty_flag, delete_file_flag],
}
)
else:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Are you SURE you want to remove these items from your' \
+ ' database? This procedure cannot be reversed!',
),
'question',
'yes-no',
None, # Parent window is main window
# Arguments passed directly to .delete_container_continue()
{
'yes': 'delete_container_continue',
'data': [media_data_obj, empty_flag, delete_file_flag],
}
)
def delete_container_continue(self, data_list):
"""Called by self.delete_container().
After getting a confirmation from the user, continue with the
deletion process.
Args:
data_list (list): A list of three items. The first is the container
media data object; the second is a flag set to True if the
container should be emptied, rather than being deleted; the
third is True if files should be deleted from the user's
filesystem
"""
# Unpack the arguments
media_data_obj = data_list[0]
empty_flag = data_list[1]
delete_file_flag = data_list[2]
if delete_file_flag:
container_dir = media_data_obj.get_default_dir(self)
if os.path.isdir(container_dir):
self.remove_directory(container_dir)
# If emptying the container rather than deleting it, just create a
# replacement (empty) directory on the filesystem
if empty_flag:
self.make_directory(container_dir)
# Now call self.delete_container_complete() to handle the media data
# registry
self.delete_container_complete(media_data_obj, empty_flag)
def delete_container_complete(self, media_data_obj, empty_flag,
recursive_flag=False):
"""Called by self.delete_container_continue(). Subsequently called by
this function recursively.
Deletes a channel, playlist or folder object from the media data
registry.
This function calls itself recursively to delete all of the container
object's descendants.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder):
The container media data object
empty_flag (bool): If True, the container media data object is to
be emptied, rather than being deleted
recursive_flag (bool): Set to False on the initial call to this
function from some other part of the code, and True when this
function calls itself recursively
"""
# Confirmation has been obtained, and any files have been deleted (if
# required), so now deal with the media data registry
# Destroy the options.OptionsManager object attached to this container
# (if any), unless it's also the one used in the Classic Mode tab
if media_data_obj.options_obj:
if (
not self.classic_options_obj \
or self.classic_options_obj != media_data_obj.options_obj
):
del self.options_reg_dict[media_data_obj.options_obj.uid]
else:
# This is the options.OptionsManager used in the Classic Mode
# tab (an unlikely situation, but possible)
self.classic_options_obj.reset_dbid()
# Update the list in any preference windows that are open
for win_obj in self.main_win_obj.config_win_list:
if isinstance(win_obj, config.SystemPrefWin):
win_obj.setup_options_dl_list_tab_update_treeview()
# Recursively remove all of the container object's children. The code
# doesn't work as intended, unless we make a copy of the list of
# child objects first
copy_list = media_data_obj.child_list.copy()
for child_obj in copy_list:
if isinstance(child_obj, media.Video):
self.delete_video(child_obj, False, True, True)
else:
self.delete_container_complete(child_obj, False, True)
if not empty_flag or recursive_flag:
# Remove the container object from its own parent object (if it has
# one)
if media_data_obj.parent_obj:
media_data_obj.parent_obj.del_child(media_data_obj)
# Reset alternative download destinations
media_data_obj.set_master_dbid(self, media_data_obj.dbid)
# Remove the media data object from our IVs
del self.media_reg_dict[media_data_obj.dbid]
del self.media_name_dict[media_data_obj.name]
if media_data_obj.name in self.media_unavailable_dict:
del self.media_unavailable_dict[media_data_obj.name]
if media_data_obj.dbid in self.media_top_level_list:
index = self.media_top_level_list.index(media_data_obj.dbid)
del self.media_top_level_list[index]
# If this container is the alternative download destination for any
# other container(s), then update the other container(s)
for other_dbid in media_data_obj.slave_dbid_list:
other_obj = self.media_reg_dict[other_dbid]
# (No reason why this check should fail, but let's play safe)
if other_obj.master_dbid == media_data_obj.dbid:
other_obj.reset_master_dbid()
# Update any profiles that depend on this container
delete_list = []
for profile_name in self.profile_dict.keys():
dbid_list = self.profile_dict[profile_name]
if media_data_obj.dbid in dbid_list:
dbid_list.remove(media_data_obj.dbid)
if not dbid_list:
# (Profiles cannot be empty)
delete_list.append(profile_name)
for profile_name in delete_list:
self.delete_profile(profile_name)
# During the initial call to this function, delete the container
# object from the Video Index (which automatically resets the Video
# Catalogue)
# (If deleting the contents of temporary folders while loading a
# Tartube database, the Video Index may not yet have been drawn, so
# we have to check for that)
if not recursive_flag and not empty_flag \
and media_data_obj.name in self.main_win_obj.video_index_row_dict:
self.main_win_obj.video_index_delete_row(media_data_obj)
# Also redraw the private folders in the Video Index, to show the
# correct number of downloaded/new videos, etc
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_all_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_bookmark_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_fav_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_live_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_missing_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_new_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_recent_folder,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
self.fixed_waiting_folder,
)
elif not recursive_flag and empty_flag:
# When emptying the container, the quickest way to update the Video
# Index is just to redraw it from scratch
self.main_win_obj.video_index_catalogue_reset()
# (Change media data object settings, updating all related things)
def prepare_mark_video(self, data_list):
"""Called by self.mark_container_favourite(),
.mark_container_missing(), .mark_container_new() and
mainwin.MainWin.on_video_index_mark_bookmark(), etc.
The procecure to mark a container's video as bookmarked or not
bookmarked (etc) can take a very long time, especially if there are
thousands of videos.
This function takes some shortcuts to reduce the time to a few
seconds.
Args:
data_list (list): List in the form
(action_type, action_flag, container_obj, video_list)
...where 'action_type' is one of the strings 'bookmark',
'favourite', 'missing', 'new' or 'waiting', 'action_flag' is
True (e,g. to bookmark a video) or False (e.g. to unbookmark a
video), 'container_obj' is a media.Channel, media.Playlist or
media.Folder object, and 'video_list' is a list of media.Video
objects to update (only specified when 'action_type' is
'favourite', 'missing' or 'new')
"""
action_type = data_list.pop(0)
action_flag = data_list.pop(0)
container_obj = data_list.pop(0)
if action_type == 'favourite' or action_type == 'missing' \
or action_type == 'new':
video_list = data_list.pop(0)
else:
video_list = container_obj.child_list
# Take some shortcuts
for child_obj in video_list:
if isinstance(child_obj, media.Video):
if action_type == 'bookmark':
self.mark_video_bookmark(
child_obj,
action_flag, # Mark video bookmarked
True, # Don't update the Video Index
True, # Don't update the Video Catalogue
True, # Don't sort the child list each time
)
elif action_type == 'favourite':
self.mark_video_favourite(
child_obj,
action_flag, # Mark video favourite (or not)
True, # Don't update the Video Index
True, # Don't update the Video Catalogue
True, # Don't sort the child list each time
)
elif action_type == 'missing':
self.mark_video_missing(
child_obj,
action_flag, # Mark video missing (or not)
True, # Don't update the Video Index
True, # Don't update the Video Catalogue
True, # Don't sort the child list each time
)
elif action_type == 'new':
self.mark_video_new(
child_obj,
action_flag, # Mark video favourite (or not)
True, # Don't update the Video Index
True, # Don't update the Video Catalogue
True, # Don't sort the child list each time
)
elif action_type == 'waiting':
self.mark_video_waiting(
child_obj,
action_flag, # Mark video waiting (or not)
True, # Don't update the Video Index
True, # Don't update the Video Catalogue
True, # Don't sort the child list each time
)
# Now we can sort the system folder's child list...
if action_type == 'bookmark':
self.fixed_bookmark_folder.sort_children(self)
elif action_type == 'favourite':
self.fixed_fav_folder.sort_children(self)
elif action_type == 'missing':
self.fixed_missing_folder.sort_children(self)
elif action_type == 'new':
self.fixed_new_folder.sort_children(self)
elif action_type == 'waiting':
self.fixed_waiting_folder.sort_children(self)
# ...and then can redraw the Video Index and Video Catalogue,
# re-selecting the current selection, if any
self.main_win_obj.video_index_catalogue_reset(True)
def mark_video_bookmark(self, video_obj, bookmark_flag, \
no_update_index_flag=False, no_update_catalogue_flag=False, \
no_sort_flag=False):
"""Can be called by anything.
Marks a video object as bookmarked or not bookmarked.
The video object's .bookmark_flag IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark
bookmark_flag (bool): True to mark the video as bookmarked, False
to mark it as not bookmarked
no_update_index_flag (bool): True if the Video Index should not be
updated (except for the system 'Bookmarks' folder), because the
calling function wants to do that itself
no_update_catalogue_flag (bool): True if rows in the Video
Catalogue should not be updated, because the calling function
wants to redraw the whole catalogue itself
no_sort_flag (bool): True if the parent container's .child_list
should not be sorted, because the calling function wants to do
that itself
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [self.fixed_bookmark_folder]
if not no_update_index_flag:
update_list.append(video_obj.parent_obj)
update_list.append(self.fixed_all_folder)
update_list.append(self.fixed_recent_folder)
if video_obj.fav_flag:
update_list.append(self.fixed_fav_folder)
if video_obj.live_mode:
update_list.append(self.fixed_live_folder)
if video_obj.missing_flag:
update_list.append(self.fixed_missing_folder)
if video_obj.new_flag:
update_list.append(self.fixed_new_folder)
if video_obj.waiting_flag:
update_list.append(self.fixed_waiting_folder)
# Mark the video as bookmarked or not bookmarked
if not isinstance(video_obj, media.Video):
return self.system_error(
157,
'Mark video as bookmarked request failed sanity check',
)
elif not bookmark_flag:
# Mark video as not bookmarked
if not video_obj.bookmark_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_bookmark_flag(False)
# Update the parent object
video_obj.parent_obj.dec_bookmark_count()
# Remove this video from the private 'Bookmarks' folder (the
# folder's count IVs are automatically updated)
self.fixed_bookmark_folder.del_child(video_obj)
# Update the Video Catalogue, if that folder is the visible one
# (deleting the row, if the 'Bookmarks' folder is visible)
if not no_update_catalogue_flag:
if self.main_win_obj.video_index_current is not None \
and self.main_win_obj.video_index_current \
== self.fixed_bookmark_folder.name:
self.main_win_obj.video_catalogue_delete_video(
video_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.dec_bookmark_count()
self.fixed_bookmark_folder.dec_bookmark_count()
if video_obj.fav_flag:
self.fixed_fav_folder.dec_bookmark_count()
if video_obj.live_mode:
self.fixed_live_folder.dec_bookmark_count()
if video_obj.missing_flag:
self.fixed_missing_folder.dec_bookmark_count()
if video_obj.new_flag:
self.fixed_new_folder.dec_bookmark_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_bookmark_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.dec_bookmark_count()
else:
# Mark video as bookmarked
if video_obj.bookmark_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_bookmark_flag(True)
# Update the parent object
video_obj.parent_obj.inc_bookmark_count()
# Add this video to the private 'Bookmarks' folder
self.fixed_bookmark_folder.add_child(
self,
video_obj,
no_sort_flag,
)
self.fixed_bookmark_folder.inc_bookmark_count()
if video_obj.dl_flag:
self.fixed_bookmark_folder.inc_dl_count()
if video_obj.fav_flag:
self.fixed_bookmark_folder.inc_fav_count()
if video_obj.live_mode:
self.fixed_bookmark_folder.inc_live_count()
if video_obj.missing_flag:
self.fixed_bookmark_folder.inc_missing_count()
if video_obj.new_flag:
self.fixed_bookmark_folder.inc_new_count()
if video_obj.waiting_flag:
self.fixed_bookmark_folder.inc_waiting_count()
# Update the Video Catalogue, if that folder is the visible one
if not no_update_catalogue_flag:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.inc_bookmark_count()
if video_obj.fav_flag:
self.fixed_fav_folder.inc_bookmark_count()
if video_obj.live_mode:
self.fixed_live_folder.inc_bookmark_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_bookmark_count()
if video_obj.new_flag:
self.fixed_new_folder.inc_bookmark_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_bookmark_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.inc_bookmark_count()
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
def mark_video_downloaded(self, video_obj, dl_flag, not_new_flag=False):
"""Can be called by anything.
Marks a video object as downloaded (i.e. the video file exists on the
user's filesystem) or not downloaded.
The video object's .dl_flag IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark.
dl_flag (bool): True to mark the video as downloaded, False to mark
it as not downloaded.
not_new_flag (bool): Set to True when called by
downloads.confirm_old_video(). The video is downloaded, but not
new
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [video_obj.parent_obj, self.fixed_all_folder]
# Mark the video as downloaded or not downloaded
if not isinstance(video_obj, media.Video):
return self.system_error(
158,
'Mark video as downloaded request failed sanity check',
)
elif not dl_flag:
# Mark video as not downloaded
if not video_obj.dl_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_dl_flag(False)
# (A video that is not downloaded cannot be marked archived)
video_obj.set_archive_flag(False)
# Update the parent container object
video_obj.parent_obj.dec_dl_count()
# Update private folders
self.fixed_all_folder.dec_dl_count()
self.fixed_new_folder.dec_dl_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.dec_dl_count()
update_list.append(self.fixed_bookmark_folder)
if video_obj.fav_flag:
self.fixed_fav_folder.dec_dl_count()
update_list.append(self.fixed_fav_folder)
if video_obj.live_mode:
self.fixed_live_folder.dec_dl_count()
update_list.append(self.fixed_live_folder)
if video_obj.missing_flag:
self.fixed_missing_folder.dec_dl_count()
update_list.append(self.fixed_missing_folder)
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_dl_count()
update_list.append(self.fixed_recent_folder)
if video_obj.waiting_flag:
self.fixed_waiting_folder.dec_dl_count()
update_list.append(self.fixed_waiting_folder)
# Also mark the video as not new (if required)...
if not not_new_flag:
self.mark_video_new(video_obj, False, True)
# ...and not missing (in all circumstances)
self.mark_video_missing(video_obj, False, True)
else:
# Mark video as downloaded
if video_obj.dl_flag:
# Already marked
return
else:
# If any ancestor channels, playlists or folders are marked as
# favourite, the video must be marked favourite as well
if video_obj.ancestor_is_favourite():
self.mark_video_favourite(video_obj, True, True)
# Update the video object's IVs
video_obj.set_dl_flag(True)
# Update the parent container object
video_obj.parent_obj.inc_dl_count()
# Update private folders
self.fixed_all_folder.inc_dl_count()
self.fixed_new_folder.inc_dl_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.inc_dl_count()
update_list.append(self.fixed_bookmark_folder)
if video_obj.fav_flag:
self.fixed_fav_folder.inc_dl_count()
update_list.append(self.fixed_fav_folder)
if video_obj.live_mode:
self.fixed_live_folder.inc_dl_count()
update_list.append(self.fixed_live_folder)
if video_obj.missing_flag:
self.fixed_missing_folder.inc_dl_count()
update_list.append(self.fixed_missing_folder)
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_dl_count()
update_list.append(self.fixed_recent_folder)
if video_obj.waiting_flag:
self.fixed_waiting_folder.inc_dl_count()
update_list.append(self.fixed_waiting_folder)
# Also mark the video as new
if not not_new_flag:
self.mark_video_new(video_obj, True, True)
# If a download options object (options.OptionsManager) has
# been applied to this video, remove it (if required)
if video_obj.options_obj and self.auto_delete_options_flag:
self.remove_download_options(video_obj)
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
def mark_video_favourite(self, video_obj, fav_flag, \
no_update_index_flag=False, no_update_catalogue_flag=False,
no_sort_flag=False):
"""Can be called by anything.
Marks a video object as favourite or not favourite.
The video object's .fav_flag IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark
fav_flag (bool): True to mark the video as favourite, False to mark
it as not favourite
no_update_index_flag (bool): True if the Video Index should not be
updated (except for the system 'Favourite Videos' folder),
because the calling function wants to do that itself
no_update_catalogue_flag (bool): True if rows in the Video
Catalogue should not be updated, because the calling function
wants to redraw the whole catalogue itself
no_sort_flag (bool): True if the parent container's .child_list
should not be sorted, because the calling function wants to do
that itself
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [self.fixed_fav_folder]
if not no_update_index_flag:
update_list.append(video_obj.parent_obj)
update_list.append(self.fixed_all_folder)
update_list.append(self.fixed_recent_folder)
if video_obj.bookmark_flag:
update_list.append(self.fixed_bookmark_folder)
if video_obj.live_mode:
update_list.append(self.fixed_live_folder)
if video_obj.missing_flag:
update_list.append(self.fixed_missing_folder)
if video_obj.new_flag:
update_list.append(self.fixed_new_folder)
if video_obj.waiting_flag:
update_list.append(self.fixed_waiting_folder)
# Mark the video as favourite or not favourite
if not isinstance(video_obj, media.Video):
return self.system_error(
159,
'Mark video as favourite request failed sanity check',
)
elif not fav_flag:
# Mark video as not favourite
if not video_obj.fav_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_fav_flag(False)
# Update the parent object
video_obj.parent_obj.dec_fav_count()
# Remove this video from the private 'Favourite Videos' folder
# (the folder's count IVs are automatically updated)
self.fixed_fav_folder.del_child(video_obj)
# Update the Video Catalogue, if that folder is the visible one
# (deleting the row, if the 'Favourite Videos' folder is
# visible)
if not no_update_catalogue_flag:
if self.main_win_obj.video_index_current is not None \
and self.main_win_obj.video_index_current \
== self.fixed_fav_folder.name:
self.main_win_obj.video_catalogue_delete_video(
video_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.dec_fav_count()
self.fixed_fav_folder.dec_fav_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.dec_fav_count()
if video_obj.live_mode:
self.fixed_live_folder.dec_fav_count()
if video_obj.missing_flag:
self.fixed_missing_folder.dec_fav_count()
if video_obj.new_flag:
self.fixed_new_folder.dec_fav_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_fav_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.dec_fav_count()
else:
# Mark video as favourite
if video_obj.fav_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_fav_flag(True)
# Update the parent object
video_obj.parent_obj.inc_fav_count()
# Add this video to the private 'Favourite Videos' folder
self.fixed_fav_folder.add_child(self, video_obj, no_sort_flag)
self.fixed_fav_folder.inc_fav_count()
if video_obj.bookmark_flag:
self.fixed_fav_folder.inc_bookmark_count()
if video_obj.dl_flag:
self.fixed_fav_folder.inc_dl_count()
if video_obj.live_mode:
self.fixed_fav_folder.inc_live_count()
if video_obj.missing_flag:
self.fixed_fav_folder.inc_missing_count()
if video_obj.new_flag:
self.fixed_fav_folder.inc_new_count()
if video_obj.waiting_flag:
self.fixed_fav_folder.inc_waiting_count()
# Update the Video Catalogue, if that folder is the visible one
if not no_update_catalogue_flag:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.inc_fav_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.inc_fav_count()
if video_obj.live_mode:
self.fixed_live_folder.inc_fav_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_fav_count()
if video_obj.new_flag:
self.fixed_new_folder.inc_fav_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_fav_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.inc_fav_count()
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
def mark_video_live(self, video_obj, live_mode, live_data_dict={}, \
no_update_index_flag=False, no_update_catalogue_flag=False, \
no_sort_flag=False):
"""Can be called by anything.
Marks a video object as a livestream.
The video object's .live_mode IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark
live_mode (int): 0 if the video is not a livestream (or if it was a
livestream which has now finished, and behaves like a normal
uploaded video), 1 if the livestream has not started, 2 if the
livestream is currently being broadcast
live_data_dict (dict): Dictionary of additional data obtained from
the YouTube STDERR message (empty for a livestream already
broadcasting, or if the message couldn't be interpreted).
Dictionary in the form
live_msg (str): Text that can be displayed in the Video
Catalogue
live_time (int): Approximate time (matching time.time()) at
which the livestream is due to start
live_debut_flag (bool): True for a YouTube 'premiere' video,
False for an ordinary livestream
no_update_index_flag (bool): True if the Video Index should not be
updated (except for the system 'Livestreams' folder), because
the calling function wants to do that itself
no_update_catalogue_flag (bool): True if rows in the Video
Catalogue should not be updated, because the calling function
wants to redraw the whole catalogue itself
no_sort_flag (bool): True if the parent container's .child_list
should not be sorted, because the calling function wants to do
that itself
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [self.fixed_live_folder]
if not no_update_index_flag:
update_list.append(video_obj.parent_obj)
update_list.append(self.fixed_all_folder)
update_list.append(self.fixed_recent_folder)
if video_obj.bookmark_flag:
update_list.append(self.fixed_bookmark_folder)
if video_obj.fav_flag:
update_list.append(self.fixed_fav_folder)
if video_obj.missing_flag:
update_list.append(self.fixed_missing_folder)
if video_obj.new_flag:
update_list.append(self.fixed_new_folder)
if video_obj.waiting_flag:
update_list.append(self.fixed_waiting_folder)
# Mark the video as a livestream or not a livestream
if not isinstance(video_obj, media.Video):
return self.system_error(
160,
'Mark video as livestream request failed sanity check',
)
elif live_mode == 0:
# Mark video as not a livestream
if video_obj.live_mode == 0:
# Already marked
return
else:
# Update the main registries
if video_obj.dbid in self.media_reg_live_dict:
del self.media_reg_live_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_alarm_dict:
del self.media_reg_auto_alarm_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_open_dict:
del self.media_reg_auto_open_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_dl_start_dict:
del self.media_reg_auto_dl_start_dict[video_obj.dbid]
if video_obj.dbid in self.media_reg_auto_dl_stop_dict:
del self.media_reg_auto_dl_stop_dict[video_obj.dbid]
# Update the video object's IVs
video_obj.set_live_mode(live_mode)
video_obj.set_was_live_flag(True)
video_obj.set_live_data(live_data_dict)
# Update the parent object
video_obj.parent_obj.dec_live_count()
# Remove this video from the private 'Livestreams' folder
# (the folder's count IVs are automatically updated)
self.fixed_live_folder.del_child(video_obj)
# Update the Video Catalogue, if that folder is the visible one
# (deleting the row, if the 'Livestreams' folder is visible)
if not no_update_catalogue_flag:
if self.main_win_obj.video_index_current is not None \
and self.main_win_obj.video_index_current \
== self.fixed_live_folder.name:
self.main_win_obj.video_catalogue_delete_video(
video_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.dec_live_count()
self.fixed_live_folder.dec_live_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.dec_live_count()
if video_obj.fav_flag:
self.fixed_fav_folder.dec_live_count()
if video_obj.missing_flag:
self.fixed_missing_folder.dec_live_count()
if video_obj.new_flag:
self.fixed_new_folder.dec_live_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_waiting_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.dec_waiting_count()
else:
# Mark video as a livestream
if video_obj.live_mode == live_mode:
# Already marked as either a 'waiting' or a 'live' livestream
return
elif video_obj.was_live_flag:
# A livestream video which has been marked as a normal video
# can never be marked as a livestream video again
# (This prevents any problems in reading the RSS feeds from
# continually marking an old video as a livestream again)
return
else:
if video_obj.live_mode == 0:
# Video was not a livestream, but now is
convert_flag = False
else:
# Video was a 'waiting' livestream, and is now 'live' (or
# vice-versa)
convert_flag = True
# Update the main registry
self.media_reg_live_dict[video_obj.dbid] = video_obj
if self.livestream_auto_notify_flag:
self.media_reg_auto_notify_dict[video_obj.dbid] = video_obj
if HAVE_PLAYSOUND_FLAG \
and self.livestream_auto_alarm_flag:
self.media_reg_auto_alarm_dict[video_obj.dbid] = video_obj
if self.livestream_auto_open_flag:
self.media_reg_auto_open_dict[video_obj.dbid] = video_obj
if self.livestream_auto_dl_start_flag:
self.media_reg_auto_dl_start_dict[video_obj.dbid] \
= video_obj
if self.livestream_auto_dl_stop_flag:
self.media_reg_auto_dl_stop_dict[video_obj.dbid] \
= video_obj
# Update the video object's IVs
video_obj.set_live_mode(live_mode)
video_obj.set_live_data(live_data_dict)
# Update the parent object
if not convert_flag:
video_obj.parent_obj.inc_waiting_count()
# Add this video to the private 'Livestreams' folder
if not convert_flag:
self.fixed_live_folder.add_child(
self,
video_obj,
no_sort_flag,
)
self.fixed_live_folder.inc_live_count()
if video_obj.bookmark_flag:
self.fixed_live_folder.inc_bookmark_count()
if video_obj.dl_flag:
self.fixed_live_folder.inc_dl_count()
if video_obj.fav_flag:
self.fixed_live_folder.inc_fav_count()
if video_obj.missing_flag:
self.fixed_live_folder.inc_missing_count()
if video_obj.new_flag:
self.fixed_live_folder.inc_new_count()
if video_obj.waiting_flag:
self.fixed_live_folder.inc_waiting_count()
# Update the Video Catalogue, if that folder is the visible one
if not no_update_catalogue_flag:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
if not convert_flag:
self.fixed_all_folder.inc_live_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.inc_live_count()
if video_obj.fav_flag:
self.fixed_fav_folder.inc_live_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_live_count()
if video_obj.new_flag:
self.fixed_new_folder.inc_live_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_live_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.inc_live_count()
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
# Changing a video's live mode almost always changes its position in
# the parent container's child list, so perform a resort
video_obj.parent_obj.sort_children(self)
def mark_video_missing(self, video_obj, missing_flag, \
no_update_index_flag=False, no_update_catalogue_flag=False, \
no_sort_flag=False):
"""Can be called by anything.
Marks a video object as missing or not missing. (A video is missing if
it has been downloaded from a channel/playlist by the user, but has
since been removed from that channel/playlist by its creator).
The video object's .missing_flag IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark
missing_flag (bool): True to mark the video as missing, False to
mark it as not missing
no_update_index_flag (bool): True if the Video Index should not be
updated, because the calling function wants to do that itself
no_update_catalogue_flag (bool): True if rows in the Video
Catalogue should not be updated, because the calling function
wants to redraw the whole catalogue itself
no_sort_flag (bool): True if the parent container's .child_list
should not be sorted, because the calling function wants to do
that itself
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [self.fixed_missing_folder]
if not no_update_index_flag:
update_list.append(video_obj.parent_obj)
update_list.append(self.fixed_all_folder)
update_list.append(self.fixed_recent_folder)
if video_obj.bookmark_flag:
update_list.append(self.fixed_bookmark_folder)
if video_obj.fav_flag:
update_list.append(self.fixed_fav_folder)
if video_obj.live_mode:
update_list.append(self.fixed_live_folder)
if video_obj.new_flag:
update_list.append(self.fixed_new_folder)
if video_obj.waiting_flag:
update_list.append(self.fixed_waiting_folder)
# Mark the video as missing or not missing
if not isinstance(video_obj, media.Video):
return self.system_error(
161,
'Mark video as missing request failed sanity check',
)
elif not missing_flag:
# Mark video as not missing
if not video_obj.missing_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_missing_flag(False)
# Update the parent object
video_obj.parent_obj.dec_missing_count()
# Remove this video from the private 'Missing Videos' folder
# (the folder's count IVs are automatically updated)
self.fixed_missing_folder.del_child(video_obj)
# Update the Video Catalogue, if that folder is the visible one
# (deleting the row, if the 'Missing Videos' folder is
# visible)
if not no_update_catalogue_flag:
if self.main_win_obj.video_index_current is not None \
and self.main_win_obj.video_index_current \
== self.fixed_missing_folder.name:
self.main_win_obj.video_catalogue_delete_video(
video_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.dec_missing_count()
self.fixed_missing_folder.dec_missing_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.dec_missing_count()
if video_obj.fav_flag:
self.fixed_fav_folder.dec_missing_count()
if video_obj.live_mode:
self.fixed_live_folder.dec_missing_count()
if video_obj.missing_flag:
self.fixed_missing_folder.dec_missing_count()
if video_obj.new_flag:
self.fixed_new_folder.dec_missing_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_missing_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.dec_missing_count()
else:
# Mark video as missing (but not if the video is not marked as
# downloaded)
if video_obj.missing_flag or not video_obj.dl_flag:
# Already marked, or not elligible
return
else:
# Update the video object's IVs
video_obj.set_missing_flag(True)
# Update the parent object
video_obj.parent_obj.inc_missing_count()
# Add this video to the private 'Missing Videos' folder
self.fixed_missing_folder.add_child(
self,
video_obj,
no_sort_flag,
)
self.fixed_missing_folder.inc_missing_count()
if video_obj.bookmark_flag:
self.fixed_missing_folder.inc_bookmark_count()
if video_obj.dl_flag:
self.fixed_missing_folder.inc_dl_count()
if video_obj.fav_flag:
self.fixed_missing_folder.inc_fav_count()
if video_obj.live_mode:
self.fixed_missing_folder.inc_live_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_missing_count()
if video_obj.new_flag:
self.fixed_missing_folder.inc_new_count()
if video_obj.waiting_flag:
self.fixed_missing_folder.inc_waiting_count()
# Update the Video Catalogue, if that folder is the visible one
if not no_update_catalogue_flag:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.inc_missing_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.inc_missing_count()
if video_obj.fav_flag:
self.fixed_fav_folder.inc_missing_count()
if video_obj.live_mode:
self.fixed_live_folder.inc_missing_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_missing_count()
if video_obj.new_flag:
self.fixed_new_folder.inc_missing_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_missing_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.inc_missing_count()
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
def mark_video_new(self, video_obj, new_flag, no_update_index_flag=False,
no_update_catalogue_flag=False, no_sort_flag=False):
"""Can be called by anything.
Marks a video object as new (i.e. unwatched by the user), or as not
new (already watched by the user).
The video object's .new_flag IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark
new_flag (bool): True to mark the video as new, False to mark it as
not new
no_update_index_flag (bool): True if the Video Index should not be
updated (except for the system 'New Videos' folder), because
the calling function wants to do that itself
no_update_catalogue_flag (bool): True if rows in the Video
Catalogue should not be updated, because the calling function
wants to redraw the whole catalogue itself
no_sort_flag (bool): True if the parent container's .child_list
should not be sorted, because the calling function wants to do
that itself
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [self.fixed_new_folder]
if not no_update_index_flag:
update_list.append(video_obj.parent_obj)
update_list.append(self.fixed_all_folder)
update_list.append(self.fixed_recent_folder)
if video_obj.bookmark_flag:
update_list.append(self.fixed_bookmark_folder)
if video_obj.fav_flag:
update_list.append(self.fixed_fav_folder)
if video_obj.live_mode:
update_list.append(self.fixed_live_folder)
if video_obj.missing_flag:
update_list.append(self.fixed_missing_folder)
if video_obj.waiting_flag:
update_list.append(self.fixed_waiting_folder)
# Mark the video as new or not new
if not isinstance(video_obj, media.Video):
return self.system_error(
162,
'Mark video as new request failed sanity check',
)
elif not new_flag:
# Mark video as not new
if not video_obj.new_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_new_flag(False)
# Update the parent object
video_obj.parent_obj.dec_new_count()
# Remove this video from the private 'New Videos' folder
# (the folder's count IVs are automatically updated)
self.fixed_new_folder.del_child(video_obj)
self.fixed_new_folder.dec_new_count()
# Update the Video Catalogue, if that folder is the visible one
# (deleting the row, if the 'New Videos' folder is visible)
if not no_update_catalogue_flag:
if self.main_win_obj.video_index_current is not None \
and self.main_win_obj.video_index_current \
== self.fixed_new_folder.name:
self.main_win_obj.video_catalogue_delete_video(
video_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.dec_new_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.dec_new_count()
if video_obj.fav_flag:
self.fixed_fav_folder.dec_new_count()
if video_obj.live_mode:
self.fixed_live_folder.dec_new_count()
if video_obj.missing_flag:
self.fixed_missing_folder.dec_new_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_new_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.dec_new_count()
else:
# Mark video as new
if video_obj.new_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_new_flag(True)
# Update the parent object
video_obj.parent_obj.inc_new_count()
# Add this video to the private 'New Videos' folder
self.fixed_new_folder.add_child(self, video_obj, no_sort_flag)
self.fixed_new_folder.inc_new_count()
if video_obj.bookmark_flag:
self.fixed_new_folder.inc_bookmark_count()
if video_obj.fav_flag:
self.fixed_new_folder.inc_fav_count()
if video_obj.live_mode:
self.fixed_new_folder.inc_live_count()
if video_obj.missing_flag:
self.fixed_new_folder.inc_missing_count()
if video_obj.waiting_flag:
self.fixed_new_folder.inc_waiting_count()
# Update the Video Catalogue, if that folder is the visible one
if not no_update_catalogue_flag:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.inc_new_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.inc_new_count()
if video_obj.fav_flag:
self.fixed_fav_folder.inc_new_count()
if video_obj.live_mode:
self.fixed_live_folder.inc_new_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_new_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_new_count()
if video_obj.waiting_flag:
self.fixed_waiting_folder.inc_new_count()
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
def mark_video_waiting(self, video_obj, waiting_flag, \
no_update_index_flag=False, no_update_catalogue_flag=False, \
no_sort_flag=False):
"""Can be called by anything.
Marks a video object as in the waiting list or not in the waiting list.
The video object's .waiting_flag IV is updated.
Args:
video_obj (media.Video): The media.Video object to mark
waiting_flag (bool): True to mark the video as in the waiting list,
False to mark it as not in the waiting list
no_update_index_flag (bool): True if the Video Index should not be
updated (except for the system 'Waiting Videos' folder),
because the calling function wants to do that itself
no_update_catalogue_flag (bool): True if rows in the Video
Catalogue should not be updated, because the calling function
wants to redraw the whole catalogue itself
no_sort_flag (bool): True if the parent container's .child_list
should not be sorted, because the calling function wants to do
that itself
"""
# (List of Video Index rows to update, at the end of this function)
update_list = [self.fixed_waiting_folder]
if not no_update_index_flag:
update_list.append(video_obj.parent_obj)
update_list.append(self.fixed_all_folder)
update_list.append(self.fixed_recent_folder)
if video_obj.bookmark_flag:
update_list.append(self.fixed_bookmark_folder)
if video_obj.fav_flag:
update_list.append(self.fixed_fav_folder)
if video_obj.live_mode:
update_list.append(self.fixed_live_folder)
if video_obj.missing_flag:
update_list.append(self.fixed_missing_folder)
if video_obj.new_flag:
update_list.append(self.fixed_new_folder)
# Mark the video as in the waiting list or not in the waiting list
if not isinstance(video_obj, media.Video):
return self.system_error(
163,
'Mark video as in waiting list request failed sanity check',
)
elif not waiting_flag:
# Mark video as not in the waiting list
if not video_obj.waiting_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_waiting_flag(False)
# Update the parent object
video_obj.parent_obj.dec_waiting_count()
# Remove this video from the private 'Waiting Videos' folder
# (the folder's count IVs are automatically updated)
self.fixed_waiting_folder.del_child(video_obj)
# Update the Video Catalogue, if that folder is the visible one
# (deleting the row, if the 'Waiting Videos' folder is
# visible)
if not no_update_catalogue_flag:
if self.main_win_obj.video_index_current is not None \
and self.main_win_obj.video_index_current \
== self.fixed_waiting_folder.name:
self.main_win_obj.video_catalogue_delete_video(
video_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.dec_waiting_count()
self.fixed_waiting_folder.dec_waiting_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.dec_waiting_count()
if video_obj.fav_flag:
self.fixed_fav_folder.dec_waiting_count()
if video_obj.live_mode:
self.fixed_live_folder.dec_waiting_count()
if video_obj.missing_flag:
self.fixed_missing_folder.dec_waiting_count()
if video_obj.new_flag:
self.fixed_new_folder.dec_waiting_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.dec_waiting_count()
else:
# Mark video as in the waiting list
if video_obj.waiting_flag:
# Already marked
return
else:
# Update the video object's IVs
video_obj.set_waiting_flag(True)
# Update the parent object
video_obj.parent_obj.inc_waiting_count()
# Add this video to the private 'Waiting Videos' folder
self.fixed_waiting_folder.add_child(
self,
video_obj,
no_sort_flag,
)
self.fixed_waiting_folder.inc_waiting_count()
if video_obj.bookmark_flag:
self.fixed_waiting_folder.inc_bookmark_count()
if video_obj.dl_flag:
self.fixed_waiting_folder.inc_dl_count()
if video_obj.fav_flag:
self.fixed_waiting_folder.inc_fav_count()
if video_obj.live_mode:
self.fixed_waiting_folder.inc_live_count()
if video_obj.missing_flag:
self.fixed_waiting_folder.inc_missing_count()
if video_obj.new_flag:
self.fixed_waiting_folder.inc_new_count()
# Update the Video Catalogue, if that folder is the visible one
if not no_update_catalogue_flag:
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Update other private folders
self.fixed_all_folder.inc_waiting_count()
if video_obj.bookmark_flag:
self.fixed_bookmark_folder.inc_waiting_count()
if video_obj.fav_flag:
self.fixed_fav_folder.inc_waiting_count()
if video_obj.live_mode:
self.fixed_live_folder.inc_waiting_count()
if video_obj.missing_flag:
self.fixed_missing_folder.inc_waiting_count()
if video_obj.new_flag:
self.fixed_new_folder.inc_waiting_count()
if video_obj in self.fixed_recent_folder.child_list:
self.fixed_recent_folder.inc_waiting_count()
# Update rows in the Video Index
for container_obj in update_list:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
container_obj,
)
def mark_folder_hidden(self, folder_obj, hidden_flag):
"""Called by callbacks in self.on_menu_show_hidden(),
.on_menu_hide_system() and
mainwin.MainWin.on_video_index_hide_folder().
Marks a folder as hidden (not visible in the Video Index) or not
hidden (visible in the Video Index, although the user might be
required to expand the tree to see it).
Args:
folder_obj (media.Folder): The folder object to mark
hidden_flag (bool): True to mark the folder as hidden, False to
mark it as not hidden
"""
if not isinstance(folder_obj, media.Folder):
return self.system_error(
164,
'Mark folder as hidden request failed sanity check',
)
if not hidden_flag:
# Mark folder as not hidden
if not folder_obj.hidden_flag:
# Already marked
return
else:
# Update the folder object's IVs
folder_obj.set_hidden_flag(False)
# Update the Video Index
self.main_win_obj.video_index_add_row(folder_obj)
else:
# Mark video as hidden
if folder_obj.hidden_flag:
# Already marked
return
else:
# Update the folder object's IVs
folder_obj.set_hidden_flag(True)
# Update the Video Index
self.main_win_obj.video_index_delete_row(folder_obj)
def mark_container_archived(self, media_data_obj, archive_flag,
only_child_videos_flag):
"""Called by mainwin.MainWin.on_video_index_mark_archived() and
.on_video_index_mark_not_archived().
Marks any descendant videos as archived.
Args:
media_data_obj (media.Channel, media.Playlist or media.Folder):
The container object to update
archive_flag (bool): True to mark as archived, False to mark as not
archived
only_child_videos_flag (bool): Set to True if only child video
objects should be marked; False if the container object and all
its descendants should be marked
"""
if isinstance(media_data_obj, media.Video):
return self.system_error(
165,
'Mark container as archived request failed sanity check',
)
# Special arrangements for private folders
if media_data_obj == self.fixed_all_folder:
# Check every video
for other_obj in list(self.media_reg_dict.values()):
if isinstance(other_obj, media.Video) and other_obj.dl_flag:
other_obj.set_archive_flag(archive_flag)
elif not archive_flag and media_data_obj == self.fixed_bookmark_folder:
# Check videos in this folder
for other_obj in self.fixed_bookmark_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag \
and other_obj.bookmark_flag:
other_obj.set_archive_flag(archive_flag)
elif not archive_flag and media_data_obj == self.fixed_fav_folder:
# Check videos in this folder
for other_obj in self.fixed_fav_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag \
and other_obj.fav_flag:
other_obj.set_archive_flag(archive_flag)
elif media_data_obj == self.fixed_live_folder:
# Check videos in this folder
for other_obj in self.fixed_live_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag \
and other_obj.live_mode:
other_obj.set_archive_flag(archive_flag)
elif media_data_obj == self.fixed_missing_folder:
# Check videos in this folder
for other_obj in self.fixed_missing_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag \
and other_obj.missing_flag:
other_obj.set_archive_flag(archive_flag)
elif media_data_obj == self.fixed_new_folder:
# Check videos in this folder
for other_obj in self.fixed_new_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag \
and other_obj.new_flag:
other_obj.set_archive_flag(archive_flag)
elif media_data_obj == self.fixed_recent_folder:
# Check videos in this folder
for other_obj in self.fixed_recent_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag:
other_obj.set_archive_flag(archive_flag)
elif media_data_obj == self.fixed_waiting_folder:
# Check videos in this folder
for other_obj in self.fixed_waiting_folder.child_list:
if isinstance(other_obj, media.Video) and other_obj.dl_flag \
and other_obj.waiting_flag:
other_obj.set_archive_flag(archive_flag)
elif only_child_videos_flag:
# Check videos in this channel/playlist/folder
for other_obj in media_data_obj.child_list:
if isinstance(other_obj, media.Video):
other_obj.set_archive_flag(archive_flag)
else:
# Check videos in this channel/playlist/folder, and in any
# descendant channels/playlists/folders
for other_obj in media_data_obj.compile_all_videos( [] ):
if isinstance(other_obj, media.Video) and other_obj.dl_flag:
other_obj.set_archive_flag(archive_flag)
# In all cases, update the row on the Video Index
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
media_data_obj,
)
# If this container is the one visible in the Video Catalogue, redraw
# the Video Catalogue
if self.main_win_obj.video_index_current == media_data_obj.name:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
def mark_container_favourite(self, media_data_obj, fav_flag,
only_child_videos_flag):
"""Called by mainwin.MainWin.on_video_index_mark_favourite() and
.on_video_index_mark_not_favourite().
Marks this channel, playlist or folder as favourite (or not favourite).
Also marks any descendant videos as (not) favourite (but not descendent
channels, playlists or folders).
Args:
media_data_obj (media.Channel, media.Playlist or media.Folder):
The container object to update
fav_flag (bool): True to mark as favourite, False to mark as not
favourite
only_child_videos_flag (bool): Set to True if only child video
objects should be marked; False if the container object and all
its descendants should be marked
"""
if isinstance(media_data_obj, media.Video):
return self.system_error(
166,
'Mark container as favourite request failed sanity check',
)
# Special arrangements for private folders. Mark the videos as
# favourite, but don't modify their parent channels, playlists and
# folders
# (For the private 'Favourite Videos' folder, don't need to do anything
# if 'fav_flag' is True, because the popup menu item is desensitised)
video_list = []
if media_data_obj == self.fixed_all_folder:
# Check every video
for other_obj in list(self.media_reg_dict.values()):
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
elif media_data_obj == self.fixed_bookmark_folder:
# Check videos in this folder
for other_obj in self.fixed_bookmark_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.bookmark_flag:
video_list.append(other_obj)
elif not fav_flag and media_data_obj == self.fixed_fav_folder:
# Check videos in this folder
for other_obj in self.fixed_fav_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.fav_flag:
video_list.append(other_obj)
elif media_data_obj == self.fixed_live_folder:
# Check videos in this folder
for other_obj in self.fixed_live_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.live_mode:
video_list.append(other_obj)
elif media_data_obj == self.fixed_missing_folder:
# Check videos in this folder
for other_obj in self.fixed_missing_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.missing_flag:
video_list.append(other_obj)
elif media_data_obj == self.fixed_new_folder:
# Check videos in this folder
for other_obj in self.fixed_new_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.new_flag:
video_list.append(other_obj)
elif media_data_obj == self.fixed_recent_folder:
# Check videos in this folder
for other_obj in self.fixed_recent_folder.child_list:
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
elif media_data_obj == self.fixed_waiting_folder:
# Check videos in this folder
for other_obj in self.fixed_waiting_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.waiting_flag:
video_list.append(other_obj)
elif only_child_videos_flag:
# Check only videos that are children of the specified media data
# object
for other_obj in media_data_obj.child_list:
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
else:
# Check only video objects that are descendants of the specified
# media data object
for other_obj in media_data_obj.compile_all_videos( [] ):
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
else:
# For channels, playlists and folders, we can set the IV
# directly
other_obj.set_fav_flag(fav_flag)
# The channel, playlist or folder itself is also marked as
# favourite (obviously, we don't do that for private folders)
media_data_obj.set_fav_flag(fav_flag)
# Take action, depending on how many videos there are
count = len(video_list)
if not count:
# Just update the row on the Video Index
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
media_data_obj,
)
elif count < self.main_win_obj.mark_video_lower_limit:
# The procedure should be quick
for child_obj in video_list:
self.mark_video_favourite(child_obj, fav_flag)
elif count < self.main_win_obj.mark_video_higher_limit:
# This will take a few seconds, so don't prompt the user
self.prepare_mark_video(
['favourite', fav_flag, media_data_obj, video_list],
)
else:
# This might take a few tens of seconds, so prompt the user for
# confirmation first
media_type = media_data_obj.get_type()
if media_type == 'channel':
msg = _(
'The channel contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
elif media_type == 'playlist':
msg = _(
'The playlist contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
else:
msg = _(
'The folder contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
msg += '\n\n' + _('Are you sure you want to continue?')
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'prepare_mark_video',
# Specified options
'data': \
['favourite', fav_flag, media_data_obj, video_list],
},
)
def mark_container_missing(self, media_data_obj, missing_flag):
"""Called by mainwin.MainWin.on_video_index_mark_missing() and
.on_video_index_mark_not_missing().
Marks this channel or playlist as missing (or not missing). Note that
this function can't be called for folders (except for the fixed
'Missing Videos' folder).
Args:
media_data_obj (media.Channel, media.Playlist or media.Folder):
The container object to update
missing_flag (bool): True to mark as missing, False to mark as not
missing
"""
if isinstance(media_data_obj, media.Video) \
or (
isinstance(media_data_obj, media.Folder) \
and media_data_obj != self.fixed_missing_folder
):
return self.system_error(
167,
'Mark container as missing request failed sanity check',
)
# Special arrangements for the 'Missing Videos' folder. Mark the
# videos as missing, but don't modify their parent channels,
# playlists and folders
video_list = []
if media_data_obj == self.fixed_missing_folder:
# Check videos in this folder
for other_obj in self.fixed_missing_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.missing_flag:
video_list.append(other_obj)
else:
# Check only videos that are children of the specified media data
# object
for other_obj in media_data_obj.child_list:
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
# Take action, depending on how many videos there are
count = len(video_list)
if not count:
# Just update the row on the Video Index
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
media_data_obj,
)
elif count < self.main_win_obj.mark_video_lower_limit:
# The procedure should be quick
for child_obj in video_list:
self.mark_video_missing(child_obj, missing_flag)
elif count < self.main_win_obj.mark_video_higher_limit:
# This will take a few seconds, so don't prompt the user
self.prepare_mark_video(
['missing', missing_flag, media_data_obj, video_list],
)
else:
# This might take a few tens of seconds, so prompt the user for
# confirmation first
media_type = media_data_obj.get_type()
if media_type == 'channel':
msg = _(
'The channel contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
elif media_type == 'playlist':
msg = _(
'The playlist contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
else:
msg = _(
'The folder contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
msg += '\n\n' + _('Are you sure you want to continue?')
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'prepare_mark_video',
# Specified options
'data': \
['missing', missing_flag, media_data_obj, video_list],
},
)
def mark_container_new(self, media_data_obj, new_flag,
only_child_videos_flag):
"""Called by mainwin.MainWin.on_video_index_mark_new() and
.on_video_index_mark_not_new().
Marks videos in this channel, playlist or folder as new (or not new).
Also marks any descendant videos as (not) new (but not descendent
channels, playlists or folders).
Unlike self.mark_container_favourite, the container itself is not
marked as new.
Args:
media_data_obj (media.Channel, media.Playlist or media.Folder):
The container object to update
new_flag (bool): True to mark as new, False to mark as not
new
only_child_videos_flag (bool): Set to True if only child video
objects should be marked; False if the container object and all
its descendants should be marked
"""
if isinstance(media_data_obj, media.Video):
return self.system_error(
168,
'Mark container as new request failed sanity check',
)
# Special arrangements for private folders
# (For the private 'Favourite Videos' folder, don't need to do anything
# if 'new_flag' is True, because the popup menu item is desensitised)
video_list = []
if media_data_obj == self.fixed_all_folder:
# Check every video
for other_obj in list(self.media_reg_dict.values()):
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
elif media_data_obj == self.fixed_bookmark_folder:
# Check videos in this folder
for other_obj in self.fixed_bookmark_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.bookmark_flag:
video_list.append(other_obj)
elif not new_flag and media_data_obj == self.fixed_fav_folder:
# Check videos in this folder
for other_obj in self.fixed_fav_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.fav_flag:
video_list.append(other_obj)
elif media_data_obj == self.fixed_live_folder:
# Check videos in this folder
for other_obj in self.fixed_live_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.live_mode:
video_list.append(other_obj)
elif media_data_obj == self.fixed_missing_folder:
# Check videos in this folder
for other_obj in self.fixed_missing_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.missing_flag:
video_list.append(other_obj)
elif media_data_obj == self.fixed_recent_folder:
# Check videos in this folder
for other_obj in self.fixed_recent_folder.child_list:
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
elif media_data_obj == self.fixed_waiting_folder:
# Check videos in this folder
for other_obj in self.fixed_waiting_folder.child_list:
if isinstance(other_obj, media.Video) \
and other_obj.waiting_flag:
video_list.append(other_obj)
elif only_child_videos_flag:
# Check only videos that are children of the specified media data
# object
for other_obj in media_data_obj.child_list:
if isinstance(other_obj, media.Video):
video_list.append(other_obj)
else:
# Check only video objects that are descendants of the specified
# media data object
for other_obj in media_data_obj.compile_all_videos( [] ):
# (Only downloaded videos can be marked as new)
if not new_flag or other_obj.dl_flag:
video_list.append(other_obj)
# Take action, depending on how many videos there are
count = len(video_list)
if not count:
# Just update the row on the Video Index
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_text,
media_data_obj,
)
elif count < self.main_win_obj.mark_video_lower_limit:
# The procedure should be quick
for child_obj in video_list:
self.mark_video_new(child_obj, new_flag)
elif count < self.main_win_obj.mark_video_higher_limit:
# This will take a few seconds, so don't prompt the user
self.prepare_mark_video(
['new', new_flag, media_data_obj, video_list],
)
else:
# This might take a few tens of seconds, so prompt the user for
# confirmation first
media_type = media_data_obj.get_type()
if media_type == 'channel':
msg = _(
'The channel contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
elif media_type == 'playlist':
msg = _(
'The playlist contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
else:
msg = _(
'The folder contains {0} item(s), so this action may' \
+ ' take a while',
).format(str(count))
msg += '\n\n' + _('Are you sure you want to continue?')
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'prepare_mark_video',
# Specified options
'data': ['new', new_flag, media_data_obj, video_list],
},
)
def rename_container(self, media_data_obj):
"""Called by mainwin.MainWin.on_video_index_rename_location().
Renames a channel, playlist or folder. Also renames the corresponding
directory in Tartube's data directory.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder): The
media data object to be renamed
"""
# Do some basic checks
if media_data_obj is None or isinstance(media_data_obj, media.Video) \
or self.current_manager_obj or self.main_win_obj.config_win_list \
or (
isinstance(media_data_obj, media.Folder) \
and media_data_obj.fixed_flag
):
return self.system_error(
169,
'Rename container request failed sanity check',
)
# Prompt the user for a new name
dialogue_win = mainwin.RenameContainerDialogue(
self.main_win_obj,
media_data_obj,
)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window, before destroying it
new_name = dialogue_win.entry.get_text()
dialogue_win.destroy()
if response == Gtk.ResponseType.OK and new_name != '' \
and new_name != media_data_obj.name:
# Check that the name is legal
if new_name is None \
or re.search('^\s*$', new_name) \
or not self.check_container_name_is_legal(new_name):
return self.dialogue_manager_obj.show_msg_dialogue(
_('The name \'{0}\' is not allowed').format(new_name),
'error',
'ok',
)
# Check that an existing channel/playlist/folder isn't already
# using this name
if new_name in self.media_name_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('The name \'{0}\' is already in use').format(new_name),
'error',
'ok',
)
# Attempt to rename the sub-directory itself
old_dir = media_data_obj.get_default_dir(self)
new_dir = media_data_obj.get_default_dir(self, new_name)
if not self.move_file_or_directory(old_dir, new_dir):
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to rename \'{0}\'').format(media_data_obj.name),
'error',
'ok',
)
# Filesystem updated, so now update the media data object itself.
# This call also updates the object's .nickname IV
old_name = media_data_obj.name
media_data_obj.set_name(new_name)
# Update the media data registries
del self.media_name_dict[old_name]
self.media_name_dict[new_name] = media_data_obj.dbid
if old_name in self.media_unavailable_dict:
del self.media_unavailable_dict[old_name]
self.media_unavailable_dict[new_name] = media_data_obj.dbid
# Update the IV which keeps track of Video Index markers, as it
# stores the container's name as a key
self.main_win_obj.video_index_update_marker(old_name, new_name)
# Reset the Video Index and the Video Catalogue (this prevents a
# lot of problems)
self.main_win_obj.video_index_catalogue_reset()
# Save the database file (since the filesystem itself has changed)
self.save_db()
def rename_container_silently(self, media_data_obj, new_name):
"""Called by self.load_db() and .rename_fixed_folder().
A modified form of self.rename_container. No dialogue windows are used,
no widgets are updated or desensitised, and the Tartube database file
is not saved.
No checks are carried out; it's up to the calling function to check
this function's return value, and respond appropriately.
Renames a channel, playlist or folder. Also renames the corresponding
directory in Tartube's data directory.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder): The
media data object to be renamed
new_name (str): The object's new name
Returns:
True on success, False on failure
"""
# Nothing in the Tartube code should be capable of calling this
# function with an illegal name, but we'll still check
if not self.check_container_name_is_legal(new_name) \
or new_name in self.media_name_dict:
self.system_error(
170,
'Illegal container name',
)
return False
# Attempt to rename the sub-directory itself
# (Private folders don't have a sub-directory to rename, so check for
# that)
if not isinstance(media_data_obj, media.Folder) \
or not media_data_obj.priv_flag:
old_dir = media_data_obj.get_default_dir(self)
new_dir = media_data_obj.get_default_dir(self, new_name)
if not self.move_file_or_directory(old_dir, new_dir):
return False
# Filesystem updated, so now update the media data object itself. This
# call also updates the object's .nickname IV
old_name = media_data_obj.name
media_data_obj.set_name(new_name)
# Update the media data registry
del self.media_name_dict[old_name]
self.media_name_dict[new_name] = media_data_obj.dbid
if old_name in self.media_unavailable_dict:
del self.media_unavailable_dict[old_name]
self.media_unavailable_dict[new_name] = media_data_obj.dbid
# Update the IV which keeps track of Video Index markers, as it stores
# the container's name as a key
self.main_win_obj.video_index_update_marker(old_name, new_name)
return True
def check_container_name_is_legal(self, name):
"""Can be called by anything.
Checks that the name of a channel, playlist or folder is legal, i.e.
that it doesn't match one of the regexes in
self.illegal_name_regex_list.
Does not check whether an existing container is already using the name;
that's the responsibility of the calling code.
Args:
name (str): A proposed name for a media.Channel, media.Playlist or
media.Folder object
Returns:
True if the name is legal, False if it is illegal
"""
for regex in self.illegal_name_regex_list:
if re.search(regex, name, re.IGNORECASE):
# Illegal name
return False
# Legal name
return True
def update_container_url(self, data_list):
"""Called by config.SystemPrefWin.on_container_url_edited().
When the user has confirmed a change to a channel/playlist's source
URL, implement that change, and update the window's treeview.
Args:
data_list (list): A list containing four items: the treeview model,
an iter pointing to a cell in the model, the media data object
and the updated URL
"""
# Extract values from the argument list
model = data_list.pop(0)
tree_iter = data_list.pop(0)
media_data_obj = data_list.pop(0)
url = data_list.pop(0)
# Update the media data object
media_data_obj.set_source(url)
model[tree_iter][3] = url
def update_container_url_multiple(self, data_list):
"""Called by config.SystemPrefWin.on_container_url_edited().
Modified version of self.update_container_url, used when performing a
substitution on the source URL of multiple channels/playlist.
Args:
data_list (list): A list containing six items: the parent
preference window, the treeview model, a list of liststore
paths, a corresponding list of media data objects to update,
the pattern and the substitution text
"""
# Extract values from the argument list
pref_win = data_list.pop(0)
model = data_list.pop(0)
mod_path_list = data_list.pop(0)
media_list = data_list.pop(0)
pattern = data_list.pop(0)
subst = data_list.pop(0)
# Search and replace the source URL for each media data object
success_count = 0
fail_count = 0
for path in mod_path_list:
media_data_obj = media_list.pop(0)
if not self.url_change_regex_flag:
mod_url = media_data_obj.source
mod_url.replace(pattern, subst)
else:
mod_url = re.sub(pattern, subst, media_data_obj.source)
if not utils.check_url(mod_url):
fail_count += 1
else:
# (Update the contents of the treeview cell immediately)
media_data_obj.set_source(mod_url)
tree_iter = model.get_iter(path)
model[tree_iter][3] = mod_url
success_count += 1
# Confirm the result
msg = _('Search/replace complete') + '\n\n' \
+ _('Updated URLs: {0}').format(success_count) + '\n' \
+ _('Errors: {0}').format(fail_count)
self.dialogue_manager_obj.show_simple_msg_dialogue(
msg,
'info',
'ok',
pref_win, # The parent window is the preference window
)
def update_container_name(self, data_list):
"""Called by config.SystemPrefWin.on_container_name_edited().
When the user has confirmed a change to a channel/playlist's name,
implement that change, and update the window's treeview.
Args:
data_list (list): A list containing four items: the treeview model,
an iter pointing to a cell in the model, the media data object
and the updated name
"""
# Extract values from the argument list
model = data_list.pop(0)
tree_iter = data_list.pop(0)
media_data_obj = data_list.pop(0)
name = data_list.pop(0)
# Update the media data object and Video Index
if self.rename_container_silently(media_data_obj, name):
model[tree_iter][2] = name
self.main_win_obj.video_index_reset()
self.main_win_obj.video_index_populate()
# (Sorting functions)
def video_compare(self, obj1, obj2):
"""Standard media.Video sorting function.
The function occurs here, rather than in utils.py, so that it's
possible to retrieve self.catalogue_sort_mode when called by
functools.cmp_to_key().
Args:
obj1, obj2 (media.Video): Two media.Video objects, one of which
must be sorted before the other
Returns:
-1 if obj1 comes before obj2, 1 if obj2 comes before obj1 (the code
does not return 0)
"""
if self.catalogue_sort_mode == 'default':
# Sort videos by livestream mode (if applicable), then by playlist
# index (if set), then by upload time, and then by receive
# (download) time
# Only if necessary do we sort by name or by .dbid (later in this
# function)
# The video's index is not relevant unless sorting a playlist (and
# not relevant in private folders, e.g. 'All Videos')
if obj1.live_mode > obj2.live_mode:
return -1
elif obj1.live_mode < obj2.live_mode:
return 1
elif obj1.live_time < obj2.live_time:
return -1
elif obj1.live_time > obj2.live_time:
return 1
elif isinstance(obj1.parent_obj, media.Playlist) \
and obj1.parent_obj == obj2.parent_obj \
and obj1.index is not None and obj2.index is not None:
if obj1.index < obj2.index:
return -1
else:
return 1
elif obj1.upload_time is not None and obj2.upload_time is not None:
if obj1.upload_time > obj2.upload_time:
return -1
elif obj1.upload_time < obj2.upload_time:
return 1
elif obj1.receive_time is not None \
and obj2.receive_time is not None:
# In private folders, the most recently received video goes
# to the top of the list
if isinstance(obj1, media.Folder) \
and obj1.parent_obj == obj2.parent_obj \
and obj1.parent_obj.priv_flag:
if obj1.receive_time > obj2.receive_time:
return -1
elif obj1.receive_time < obj2.receive_time:
return 1
# ...but for everything else, the sorting algorithm is the
# same as for media.GenericRemoteContainer.do_sort(), in
# which we assume the website is sending us videos,
# newest first
else:
if obj1.receive_time < obj2.receive_time:
return -1
elif obj1.receive_time > obj2.receive_time:
return 1
elif self.catalogue_sort_mode == 'receive' \
and obj1.receive_time is not None \
and obj2.receive_time is not None:
if obj1.receive_time < obj2.receive_time:
return -1
elif obj1.receive_time > obj2.receive_time:
return 1
elif self.catalogue_sort_mode == 'dbid':
if obj1.dbid < obj2.dbid:
return -1
else:
return 1
# Fallback sorting method (including when self.catalogue_sort_mode is
# set to 'alpha'):
# Sort alphabetically, then by .dbid
if obj1.name.lower() < obj2.name.lower():
return -1
elif obj1.name.lower() > obj2.name.lower():
return 1
elif obj1.dbid < obj2.dbid:
return -1
else:
return 1
def folder_child_compare(self, obj1, obj2):
"""Standard folder sorting function, called by
media.Folder.sort_children().
The function occurs here, rather than in utils.py, so that it's
possible to retrieve self.catalogue_sort_mode when called by
functools.cmp_to_key().
Standard sorting function for the children of a container, which might
be any combination of media.Video, media.Channel, media.Playlist and
media.Folder objects.
Args:
obj1, obj2 (media.Video): Two media data objects, one of which
must be sorted before the other
"""
if str(obj1.__class__) == str(obj2.__class__) \
or (
isinstance(obj1, media.GenericRemoteContainer) \
and isinstance(obj2, media.GenericRemoteContainer)
):
if isinstance(obj1, media.Video):
# If both objects are media.Video objects, use the standard
# video sorting function
return self.video_compare(obj1, obj2)
else:
# If the objects are of different class, then we can sort by class
if isinstance(obj1, media.Folder):
return -1
elif isinstance(obj2, media.Folder):
return 1
elif isinstance(obj1, media.Channel) \
or isinstance(obj1, media.Playlist):
return -1
elif isinstance(obj2, media.Channel) \
or isinstance(obj2, media.Playlist):
return 1
# As a last restor, sort by name, and then by .dbid
if obj1.name.lower() < obj2.name.lower():
return -1
elif obj1.name.lower() > obj2.name.lower():
return 1
elif obj1.dbid < obj2.dbid:
return -1
else:
return 1
# (Export/import data to/from the Tartube database)
def export_from_db(self, media_list):
"""Called by self.on_menu_export_db() and
mainwin.MainWin.on_video_index_export().
Exports a summary of the Tartube database to an export file - either a
structured JSON file, or a CSV file, or a plain text file, at the
user's option.
The export file typically contains a list of videos, channels,
playlists and folders, but not any downloaded files (videos,
thumbnails, etc).
The export file is not the same as a Tartube database file (usually
tartube.db) and cannot be loaded as a database file. However, the
export file can be imported into an existing database.
Args:
media_list (list): A list of media data objects. If specified, only
those objects (and any media data objects they contain) are
included in the export. If an empty list is passed, the whole
database is included.
"""
# If the specified list is empty, a summary of the whole database is
# exported
if not media_list:
whole_flag = True
else:
whole_flag = False
# Prompt the user for which kinds of media data object should be
# included in the export, and which type of file (JSON or plain text)
# should be created
dialogue_win = mainwin.ExportDialogue(self.main_win_obj, whole_flag)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
include_video_flag = dialogue_win.checkbutton.get_active()
include_channel_flag = dialogue_win.checkbutton2.get_active()
include_playlist_flag = dialogue_win.checkbutton3.get_active()
preserve_folder_flag = dialogue_win.checkbutton4.get_active()
json_flag = dialogue_win.radiobutton.get_active()
csv_flag = dialogue_win.radiobutton2.get_active()
plain_text_flag = dialogue_win.radiobutton3.get_active()
separator = dialogue_win.separator
# ...before destroying the dialogue window
dialogue_win.destroy()
if response != Gtk.ResponseType.OK:
return
# Prompt the user for the file path to use
if json_flag:
suggestion = self.export_json_file_name
elif csv_flag:
suggestion = self.export_csv_file_name
else:
suggestion = self.export_text_file_name
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select where to save the database export'),
self.main_win_obj,
'save',
suggestion,
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Compile a dictionary of data to export, representing the contents of
# the database (in whole or in part)
# Throughout the export/import code, dictionaries in this form are
# called 'db_dict'
# Depending on the user's choices, the dictionary preserves the folder
# structure of the database (or not)
#
# Key-value pairs in the dictionary are in the form
#
# dbid: mini_dict
#
# 'dbid' is each media data object's .dbid
# 'mini_dict' is a dictionary of values representing a media data
# object
#
# The same 'mini_dict' structure is used during export and
# import procedures. Its keys are:
#
# type - set to 'video', 'channel', 'playlist' or 'folder'
# dbid - set to the media data object's .dbid
# vid - set to the media data object's .vid (or None for
# channels, playlists and folders)
# name - set to the media data object's .name IV
# nickname - set to the media data object's .nickname IV (or
# None for videos)
# file - set to the filename and extension of a video
# (e.g. 'video.mp4'; None for channels, playlists
# and folders)
# source - set to the media data object's .source IV (or
# None for folders)
# db_dict - the children of this media data object, stored in
# the form described above
#
# The import process adds some extra keys to a 'mini_dict' while
# processing it, but only for channels/playlists/folders. The extra
# keys are:
#
# display_name
# - the media data object's name, indented for display
# in mainwin.ImportDialogue
# video_count
# - the number of videos this media data object contains
# import_flag
# - True if the user has selected this media data object
# to be imported, False if they have deselected it
db_dict = {}
# Compile the contents of the 'db_dict' to export
# If the media_list argument is empty, use the whole database.
# Otherwise, use only the specified media data objects (and any media
# data objects they contain)
if preserve_folder_flag:
if media_list:
for media_data_obj in media_list:
mini_dict = media_data_obj.prepare_export(
self,
include_video_flag,
include_channel_flag,
include_playlist_flag,
)
if mini_dict:
db_dict[media_data_obj.dbid] = mini_dict
else:
for dbid in self.media_top_level_list:
media_data_obj = self.media_reg_dict[dbid]
mini_dict = media_data_obj.prepare_export(
self,
include_video_flag,
include_channel_flag,
include_playlist_flag,
)
if mini_dict:
db_dict[media_data_obj.dbid] = mini_dict
else:
if media_list:
for media_data_obj in media_list:
db_dict = media_data_obj.prepare_flat_export(
self,
db_dict,
include_video_flag,
include_channel_flag,
include_playlist_flag,
)
else:
for dbid in self.media_top_level_list:
media_data_obj = self.media_reg_dict[dbid]
db_dict = media_data_obj.prepare_flat_export(
self,
db_dict,
include_video_flag,
include_channel_flag,
include_playlist_flag,
)
if not db_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('There is nothing to export!'),
'error',
'ok',
)
# Export a JSON file
if json_flag:
# The exported JSON file has the same metadata as a config file,
# with only the 'file_type' being different
# Prepare values
local = utils.get_local_time()
# Prepare a dictionary of data to save as a JSON file
json_dict = {
# Metadata
'script_name': __main__.__packagename__,
'script_version': __main__.__version__,
'save_date': str(local.strftime('%d %b %Y')),
'save_time': str(local.strftime('%H:%M:%S')),
'file_type': 'db_export',
# Data
'db_dict': db_dict,
}
# Try to save the file
try:
with open(file_path, 'w') as outfile:
json.dump(json_dict, outfile, indent=4)
# # DEBUG: Git 143: provide more information on the exception
# except:
# return self.dialogue_manager_obj.show_msg_dialogue(
# _('Failed to save the database export file'),
# 'error',
# 'ok',
# )
except Exception as e:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to save the database export file:') \
+ '\n\n' + str(e),
'error',
'ok',
)
# Export a CSV file
elif csv_flag:
# Update the CSV separator, before writing the file
self.export_csv_separator = separator
# Lines in the CSV file are in the following format:
# type|name|url|container_name|vid|file
#
# 'type' is one of 'video', 'channel', 'playlist' or 'folder'
# For folders, 'url' is unspecified
# 'vid' and 'file' are only specified for videos
# If there is no parent container, 'container_name' is unspecified.
# The parent container must be listed before its children
# The separator is specified by self.export_csv_separator; the
# default value is '|'
# Prepare the list of lines
line_list = self.export_from_db_to_csv_insert(
db_dict,
[],
include_video_flag,
)
# Try to save the file
try:
with open(file_path, 'w') as outfile:
for line in line_list:
outfile.write(line + '\n')
# # DEBUG: Git 143: provide more information on the exception
# except:
# return self.dialogue_manager_obj.show_msg_dialogue(
# _('Failed to save the database export file'),
# 'error',
# 'ok',
# )
except Exception as e:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to save the database export file:') \
+ '\n\n' + str(e),
'error',
'ok',
)
# Export a plain text file
else:
# v2.3.208: In a change from earlier versions, the text file now
# contains lines in groups of four, in the following format:
#
# @type
# <name>
# <url>
# <container name>
#
# For videos, a group of six is used, in the format
#
# @type
# <name>
# <url>
# <container name>
# <vid>
# <filename>
#
# '@type' is one of '@video', '@channel', '@playlist' or '@folder'
# For folders, <url> is an empty line
# If there is no parent container, <container_name> is an empty
# line. The parent container is always listed before its children
# Prepare the list of lines
line_list = self.export_from_db_to_text_insert(
db_dict,
[],
include_video_flag,
)
# Try to save the file
try:
with open(file_path, 'w') as outfile:
for line in line_list:
outfile.write(line + '\n')
# # DEBUG: Git 143: provide more information on the exception
# except:
# return self.dialogue_manager_obj.show_msg_dialogue(
# _('Failed to save the database export file'),
# 'error',
# 'ok',
# )
except Exception as e:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to save the database export file:') \
+ '\n\n' + str(e),
'error',
'ok',
)
# Export was successful
self.dialogue_manager_obj.show_msg_dialogue(
_('Database export file saved to:') + '\n\n' + file_path,
'info',
'ok',
)
def export_from_db_to_text_insert(self, db_dict, line_list, \
include_video_flag):
"""Called by self.export_from_db(), and then by this function
recursively.
self.export_from_db() is trying to convert the dictionary 'db_dict' (in
the form described in the comments in self.export_from_db() ) into a
flat list of lines, in groups of four, to be saved as the plaint text
export file.
The 'db_dict' passed as an argument to this function is either the
overall dictionary, or a sub-dictionary inside the original, in the
same format. Again, this is described in self.export_from_db().
This file is called recursively to walk the overall dictionary, and to
insert four items into 'line_list' for every media data object.
Args:
db_dict (dict): Either the original 'db_dict', or one of its
sub-dictionaries in the same format
line_list (list): The list of lines to be saved as the text export
file; this call adds more lines to the list, before returning
it
include_video_flag (bool): If True, media.Video objects are to be
included in the export file; if False, they are ignored
Return values:
The updated 'line_list'
"""
for dbid in db_dict.keys():
mini_dict = db_dict[dbid]
media_data_obj = self.media_reg_dict[dbid]
if isinstance(media_data_obj, media.Video):
# (Child videos of this media data object have already been
# handled, by the code below)
continue
else:
if isinstance(media_data_obj, media.Folder):
line_list.append('@folder')
line_list.append(media_data_obj.name)
# Folders have no URL
line_list.append('')
else:
if media_data_obj.source is not None:
source = media_data_obj.source
else:
source = ''
if isinstance(media_data_obj, media.Channel):
line_list.append('@channel')
line_list.append(media_data_obj.name)
line_list.append(source)
else:
line_list.append('@playlist')
line_list.append(media_data_obj.name)
line_list.append(source)
if media_data_obj.parent_obj:
line_list.append(media_data_obj.parent_obj.name)
else:
line_list.append('')
if include_video_flag:
for child_obj in media_data_obj.child_list:
if isinstance(child_obj, media.Video):
line_list.append('@video')
line_list.append(child_obj.name)
if child_obj.source is not None:
line_list.append(child_obj.source)
else:
line_list.append('')
line_list.append(media_data_obj.name)
if child_obj.vid is not None:
line_list.append(child_obj.vid)
else:
line_list.append('')
if child_obj.file_name is not None \
and child_obj.file_ext is not None:
line_list.append(
child_obj.file_name + child_obj.file_ext,
)
else:
line_list.append('')
if mini_dict['db_dict']:
line_list = self.export_from_db_to_text_insert(
mini_dict['db_dict'],
line_list,
include_video_flag,
)
return line_list
def export_from_db_to_csv_insert(self, db_dict, line_list, \
include_video_flag):
"""Called by self.export_from_db(), and then by this function
recursively.
self.export_from_db() is trying to convert the dictionary 'db_dict' (in
the form described in the comments in self.export_from_db() ) into a
flat list of lines, to be saved as the CSV export file.
The 'db_dict' passed as an argument to this function is either the
overall dictionary, or a sub-dictionary inside the original, in the
same format. Again, this is described in self.export_from_db().
This file is called recursively to walk the overall dictionary, and to
insert a line into 'line_list' for every media data object.
Args:
db_dict (dict): Either the original 'db_dict', or one of its
sub-dictionaries in the same format
line_list (list): The list of lines to be saved as the CSV export
file; this call adds more lines to the list, before returning
it
include_video_flag (bool): If True, media.Video objects are to be
included in the export file; if False, they are ignored
Return values:
The updated 'line_list'
"""
separator = self.export_csv_separator
for dbid in db_dict.keys():
mini_dict = db_dict[dbid]
media_data_obj = self.media_reg_dict[dbid]
if isinstance(media_data_obj, media.Video):
# (Child videos of this media data object have already been
# handled, by the code below)
continue
else:
if isinstance(media_data_obj, media.Folder):
# Folders have no URL
line = 'folder' + separator + media_data_obj.name \
+ separator + separator
else:
if media_data_obj.source is not None:
source = media_data_obj.source
else:
source = ''
if isinstance(media_data_obj, media.Channel):
line = 'channel' + separator + media_data_obj.name \
+ separator + source + separator
else:
line = 'playlist' + separator + media_data_obj.name \
+ separator + source + separator
if media_data_obj.parent_obj:
line += media_data_obj.parent_obj.name
# (Channels, playlists and folders do not have the .vid,
# .file_name or .file_ext IVs
line += separator + separator
line_list.append(line)
if include_video_flag:
for child_obj in media_data_obj.child_list:
if isinstance(child_obj, media.Video):
# Create a line in the form
# type|name|url|container_name|vid|file
line = 'video' + separator + child_obj.name \
+ separator
if child_obj.source is not None:
line += child_obj.source + separator
else:
line += separator
line += media_data_obj.name + separator
if child_obj.vid is not None:
line += child_obj.vid + separator
else:
line += separator
if child_obj.file_name is not None \
and child_obj.file_ext is not None:
line += child_obj.file_name \
+ child_obj.file_ext
line_list.append(line)
if mini_dict['db_dict']:
line_list = self.export_from_db_to_csv_insert(
mini_dict['db_dict'],
line_list,
include_video_flag,
)
return line_list
def import_into_db(self):
"""Called by self.on_menu_import_db().
Imports the contents of a JSON/CSV/plain text export file generated by
a call to self.export_from_db().
After prompting the user, creates new media.Video, media.Channel,
media.Playlist and/or media.Folder objects. Checks for duplicates and
handles them appropriately.
A JSON export file contains a dictionary, 'db_dict', containing further
dictionaries, 'mini_dict', whose formats are described in the comments
in self.export_from_db().
A CSV export file contains lines in the format
'type|name|url|container_name|vid|file', as described in the comments
in self.export_from_db().
A plain text export file contains lines in groups of four (or groups of
six for videos), in the format described in the comments in
self.export_from_db().
"""
# Prompt the user for the export file to load
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select the database export'),
self.main_win_obj,
'open',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
file_name, file_ext = os.path.splitext(file_path)
if file_ext != '.json' and file_ext != '.csv' and file_ext != '.txt':
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to load the database export file'),
'error',
'ok',
)
# Try to load the export file
if file_ext == '.json':
json_dict = self.file_manager_obj.load_json(file_path)
if not json_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to load the database export file'),
'error',
'ok',
)
# Do some basic checks on the loaded data
# (At the moment, JSON export files are compatible with all
# versions of Tartube after v1.0.0; this may change in future)
if not json_dict \
or not 'script_name' in json_dict \
or not 'script_version' in json_dict \
or not 'save_date' in json_dict \
or not 'save_time' in json_dict \
or not 'file_type' in json_dict \
or json_dict['script_name'] != __main__.__packagename__ \
or json_dict['file_type'] != 'db_export':
return self.dialogue_manager_obj.show_msg_dialogue(
_('The database export file is invalid'),
'error',
'ok',
)
# Retrieve the database data itself. db_dict is in the form
# described in the comments in self.export_from_db()
# However, json.dump() has converted integer keys to string keys.
# Each key is a 'fake' dbid, so this doesn't affect the outcome
# (and it's not worth converting them back to integers)
db_dict = json_dict['db_dict']
else:
text = self.file_manager_obj.load_text(file_path)
if text is None:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to load the database export file'),
'error',
'ok',
)
# Parse the text file, creating a db_dict in the form described in
# the comments in self.export_from_db()
if file_ext == '.csv':
db_dict = self.parse_csv_import(text)
else:
db_dict = self.parse_text_import(text)
if not db_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('The database export file is invalid (or empty)'),
'error',
'ok',
)
# Prompt the user to allow them to select which videos/channels/
# playlists/folders to actually import, and how to deal with
# duplicate channels/playlists/folders
dialogue_win = mainwin.ImportDialogue(self.main_win_obj, db_dict)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window, before destroying the
# dialogue window
# 'flat_db_dict' is a flattened version of the imported 'db_dict' (i.e.
# with its folder structure removed), and with additional key-value
# pairs added to each 'mini_dict'. (The new key-value pairs are also
# described in the comments in self.export_from_db() )
import_videos_flag = dialogue_win.checkbutton.get_active()
merge_duplicates_flag = dialogue_win.checkbutton.get_active()
flat_db_dict = dialogue_win.flat_db_dict
dialogue_win.destroy()
if response != Gtk.ResponseType.OK:
return
# Process the imported 'db_dict', creating new videos/channels/
# playlists/folders as required, and dealing appropriately with
# any duplicates
(video_count, channel_count, playlist_count, folder_count) \
= self.process_import(
db_dict, # The imported data
flat_db_dict, # The flattened version of that dictionary
None, # No parent 'mini_dict' yet
import_videos_flag,
merge_duplicates_flag,
False, # Do not import into the selected folder
0, # video_count
0, # channel_count
0, # playlist count
0, # folder_count
)
if not video_count and not channel_count and not playlist_count \
and not folder_count:
self.dialogue_manager_obj.show_msg_dialogue(
_('Nothing was imported from the database export file'),
'error',
'ok',
)
else:
# Update the Video Catalogue, in case any new videos have been
# imported into it
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
# Show a confirmation
msg = _('Imported into database') \
+ ':\n\n' + _('Videos') + ': ' + str(video_count) \
+ '\n' + _('Channels') + ': ' + str(channel_count) \
+ '\n' + _('Playlists') + ': ' + str(playlist_count) \
+ '\n' + _('Folders') + ': ' + str(folder_count)
self.dialogue_manager_obj.show_simple_msg_dialogue(
msg,
'info',
'ok',
)
def parse_csv_import(self, text):
"""Called by self.import_into_db().
Given the contents of a CSV database export, which has been loaded into
memory, convert the contents into the db_dict format described in the
comments in self.export_from_db(), as if a JSON database export had
been loaded.
A CSV export file contains lines in the format
'type|name|url|container_name|vid|file', as described in the comments
in self.export_from_db().
'type' is one of 'video', 'channel', 'playlist' or 'folder'.
For folders, <url> is not specified. 'vid' and 'file' are only
specified for videos.
If there is no parent container, <container_name> is not specified. The
parent container must be listed before its children
Args:
text (str): The contents of the loaded CSV file
Returns:
db_dict (dict): The converted data in the form described in the
comments in self.export_from_db()
"""
db_dict = {}
fake_dbid = 0
check_flag = False
separator = '\\' + self.export_csv_separator
regex = '^(.*)' + separator + '(.*)' + separator + '(.*)' + separator \
+ '(.*)' + separator + '(.*)' + separator + '(.*)'
# Create entries corresponding to the fixed folders 'Unsorted Videos'
# and 'Video Clips'
fake_dbid += 1
db_dict[fake_dbid] = {
'type': 'folder',
'dbid': fake_dbid,
'vid': None,
'name': self.fixed_misc_folder.name,
'nickname': self.fixed_misc_folder.nickname,
'file': None,
'source': None,
'db_dict': {},
}
fake_dbid += 1
db_dict[fake_dbid] = {
'type': 'folder',
'dbid': fake_dbid,
'vid': None,
'name': self.fixed_clips_folder.name,
'nickname': self.fixed_clips_folder.nickname,
'file': None,
'source': None,
'db_dict': {},
}
# Split text into separate lines
line_list = text.split('\n')
# Extract fields from each line, and check they are valid
# If any line is invalid, ignore that line and any subsequent lines,
# and just use the data already extracted
for line in line_list:
match = re.search(regex, line)
if not match:
break
media_type = match.groups()[0]
name = match.groups()[1]
source = match.groups()[2]
container_name = match.groups()[3]
vid = match.groups()[4]
filename = match.groups()[5]
if (
media_type != 'video' and media_type != 'channel' \
and media_type != 'playlist' and media_type != 'folder' \
) \
or name == '' \
or (
media_type != 'folder' \
and source != '' \
and not utils.check_url(source) \
):
break
# If the original media data object's .source/.vid/.file_name/
# .file_ext IVs were set to None, they were saved as empty lines
if source == '':
source = None
if vid == '':
vid = None
if filename == '':
filename = None
# (We have already created entries for 'Unsorted Videos' and
# 'Video Clips')
if name != self.fixed_misc_folder.name \
and name != self.fixed_clips_folder.name:
# A valid line; add an entry to db_dict using a fake dbid
fake_dbid += 1
mini_dict = {
'type': media_type,
'dbid': fake_dbid,
'vid': vid,
'name': name,
'nickname': name,
'file': filename,
'source': source,
'db_dict': {},
}
# If the name for a parent container was specified, look for a
# match in 'db_dict'. (The parent should have been specified
# earlier in the file, so it will already exist in db_dict)
# If found, self.parse_import_insert() inserts mini_dict into
# db_dict at the correct location
# If not found, a video is inserted into 'Unsorted Videos', and
# everything else is not given a parent container
if not re.search('\S', container_name):
# No parent container specified
db_dict[fake_dbid] = mini_dict
elif not self.parse_import_insert(
db_dict,
container_name,
fake_dbid,
mini_dict,
):
# No parent container found
if media_type == '@video':
# As specified above, the 'Unsorted Videos' folder uses
# the 'fake_dbid' of 1
db_dict[1]['db_dict'][fake_dbid] = mini_dict
else:
# This channel/playlist/folder goes into the top level
# of the media data registry
db_dict[fake_dbid] = mini_dict
# Procedure complete
if fake_dbid == 2:
return {} # Nothing was actually imported
else:
return db_dict
def parse_text_import(self, text):
"""Called by self.import_into_db().
Given the contents of a plain text database export, which has been
loaded into memory, convert the contents into the db_dict format
described in the comments in self.export_from_db(), as if a JSON
database export had been loaded.
The text file contains lines, in groups of four, in the following
format:
@type
<name>
<url>
<container name>
For videos, a group of six is used, in the format:
@type
<name>
<url>
<container name>
<vid>
<filename>
'@type' is one of '@video', '@channel', '@playlist' or '@folder'
For folders, <url> is an empty line
If there is no parent container, <container_name> is an empty line. The
parent container must be listed before its children
N.B. The export format changed in v2.3.208, and again in v2.3.337. This
function will try to recognise exports from earlier versions, but it's
not guaranteed to work.
Args:
text (str): The contents of the loaded plain text file
Returns:
db_dict (dict): The converted data in the form described in the
comments in self.export_from_db()
"""
db_dict = {}
fake_dbid = 0
check_flag = False
video_check_flag = False
# Create entries corresponding to the fixed folders 'Unsorted Videos'
# and 'Video Clips'
fake_dbid += 1
db_dict[fake_dbid] = {
'type': 'folder',
'dbid': fake_dbid,
'vid': None,
'name': self.fixed_misc_folder.name,
'nickname': self.fixed_misc_folder.nickname,
'file': None,
'source': None,
'db_dict': {},
}
fake_dbid += 1
db_dict[fake_dbid] = {
'type': 'folder',
'dbid': fake_dbid,
'vid': None,
'name': self.fixed_clips_folder.name,
'nickname': self.fixed_clips_folder.nickname,
'file': None,
'source': None,
'db_dict': {},
}
# Split text into separate lines
line_list = text.split('\n')
# Extract each group of four lines, and check they are valid
# If a group of four/six is invalid (or if we reach the end of the file
# in the middle of a group of), ignore that group and any subsequent
# groups, and just use the data already extracted
# Spltting by '\n' will create a group with just one empty line, so
# we don't check that line_list is empty
while len(line_list) > 1:
media_type = line_list[0]
name = line_list[1]
source = line_list[2]
container_name = line_list[3]
vid = None
filename = None
# Basic checks
if media_type is None \
or (
media_type != '@video' and media_type != '@channel' \
and media_type != '@playlist' and media_type != '@folder' \
) \
or name is None \
or name == '' \
or source is None \
or (
media_type != '@folder' \
and source != '' \
and not utils.check_url(source) \
) \
or container_name is None:
break
# The export format changed in v2.3.208. Try to detect exports
# from earlier versions (this is not guaranteed to work)
if not check_flag:
check_flag = True
if container_name == '@video' \
or container_name == '@channel' \
or container_name == '@playlist' \
or container_name == '@folder':
break
# The export format changed again in v2.3.337, to use groups of six
# for videos
if media_type != '@video':
line_list = line_list[4:]
else:
vid = line_list[4]
filename = line_list[5]
line_list = line_list[6:]
# More basic checks, and try to detect exports from earlier
# versions
if vid is None or filename is None:
break
if not video_check_flag:
video_check_flag = True
if vid == '@video' \
or vid == '@channel' \
or vid == '@playlist' \
or vid == '@folder':
break
# If the original media data object's .source/.vid/.file_name/
# .file_ext IVs were set to None, they were saved as empty lines
if source == '':
source = None
if vid == '':
vid = None
if filename == '':
filename = None
# (We have already created entries for 'Unsorted Videos' and
# 'Video Clips')
if name != self.fixed_misc_folder.name \
and name != self.fixed_clips_folder.name:
# A valid group of four/six; add an entry to db_dict using a
# fake dbid
fake_dbid += 1
mini_dict = {
'type': media_type[1:], # Remove initial @
'dbid': fake_dbid,
'vid': vid,
'name': name,
'nickname': name,
'file': filename,
'source': source,
'db_dict': {},
}
# If the name for a parent container was specified, look for a
# match in 'db_dict'. (The parent should have been specified
# earlier in the file, so it will already exist in db_dict)
# If found, self.parse_import_insert() inserts mini_dict into
# db_dict at the correct location
# If not found, a video is inserted into 'Unsorted Videos', and
# everything else is not given a parent container
if not re.search('\S', container_name):
# No parent container specified
db_dict[fake_dbid] = mini_dict
elif not self.parse_import_insert(
db_dict,
container_name,
fake_dbid,
mini_dict,
):
# No parent container found
if media_type == '@video':
# As specified above, the 'Unsorted Videos' folder uses
# the 'fake_dbid' of 1
db_dict[1]['db_dict'][fake_dbid] = mini_dict
else:
# This channel/playlist/folder goes into the top level
# of the media data registry
db_dict[fake_dbid] = mini_dict
# Procedure complete
if fake_dbid == 2:
return {} # Nothing was actually imported
else:
return db_dict
def parse_import_insert(self, db_dict, container_name,
insert_fake_dbid, insert_mini_dict):
"""Called by self.parse_text_import(), and then by this function
recursively.
self.parse_text_import() is trying to convert a text export file into
a dictionary, 'db_dict', in the form described in the comments in
self.export_from_db().
The 'db_dict' passed as an argument to this function is either the
overall dictionary, or a sub-dictionary inside the original, in the
same format. Again, this is described in self.export_from_db().
This file is called to find the entry corresponding to a channel/
playlist/folder called 'container_name', so an entry for a new video/
channel/playlist/folder can be inserted into it as a child object.
Search the original 'db_dict' recursively until the correct entry is
found.
Args:
db_dict (dict): Either the original 'db_dict', or one of its
sub-dictionaries in the same format
container_name (str): The name of the parent container
insert_fake-dbid (int): A fake .dbid for the child object to be
inserted
insert_mini_dict (dict): The 'db_dict' for the child object to be
inserted, specifying its attributes
Return values:
True if the correct entry has been found (either by this function
call, or by one of its recursive function calls); False if the
correct entry hasn't been found yet
"""
for this_fake_dbid in db_dict:
this_mini_dict = db_dict[this_fake_dbid]
if this_mini_dict['type'] != 'video' \
and this_mini_dict['name'] == container_name:
this_mini_dict['db_dict'][insert_fake_dbid] = insert_mini_dict
return True
elif self.parse_import_insert(
this_mini_dict['db_dict'],
container_name,
insert_fake_dbid,
insert_mini_dict,
):
# mini_dict has been inserted at its correct location, so now
# we can stop checking
return True
# mini_dict not inserted at its correct location yet
return False
def process_import(self, db_dict, flat_db_dict, parent_obj,
import_videos_flag, merge_duplicates_flag, selected_is_parent_flag,
video_count, channel_count, playlist_count, folder_count):
"""Called by self.import_into_db(). Subsequently called by this
function recursively.
Also called by wizwin.ImportYTWizWin.applychanges().
Process a 'db_dict' (in the format described in the comments in
self.export_from_db() ).
Create new videos/channels/playlists/folders as required, and deal
appropriately with any duplicates.
Args:
db_dict (dict): The dictionary described in self.export_from_db();
if called from self.import_into_db(), the original imported
dictionary; if called recursively, a dictionary from somewhere
inside the original imported dictionary
flat_db_dict (dict): A flattened version of the original imported
'db_dict' (not necessarily the same 'db_dict' provided by the
argument above). Flattened means that the folder structure has
been removed, and additional key-value pairs have been added to
each 'mini_dict' (described in comments in
self.export_from_db() )
parent_obj (media.Channel, media.Playlist, media.Folder or None):
The contents of db_dict are all children of this parent media
data object
import_videos_flag (bool): If True, any video objects are imported.
If False, video objects are ignored
merge_duplicates_flag (bool): If True, imported channels/playlists/
folders with the same name (and source URL) as an existing
channel/playlist/folder are merged with them. If False, the
imported channel/playlist/folder is renamed
selected_is_parent_flag (bool): If True, and if a non-system folder
is selected in the Video Index, then everything is imported
into that folder
video_count, channel_count, playlist_count, folder_count (int): The
total number of videos/channels/playlists/folders imported so
far
Returns:
video_count, channel_count, playlist_count, folder_count (int): The
updated counts after importing videos/channels/playlists/
folders
"""
url_check_dict = {}
if parent_obj:
# To optimise the code below, compile a dictionary for quick
# lookup, containing the source URLs for all videos in the parent
# channel/playlist/folder
for child_obj in parent_obj.child_list:
if isinstance(child_obj, media.Video) \
and child_obj.source is not None:
url_check_dict[child_obj.source] = None
elif selected_is_parent_flag \
and self.main_win_obj.video_index_current is not None:
# When called from the 'Import YouTube subscriptions' wizard
# window, import everything into a non-system folder, if one is
# selected
selected_dbid \
= self.media_name_dict[self.main_win_obj.video_index_current]
selected_obj = self.media_reg_dict[selected_dbid]
if isinstance(selected_obj, media.Folder) \
and not selected_obj.fixed_flag:
parent_obj = selected_obj
# Because of recursion, reset the flag; we only need to do this
# once
selected_is_parent_flag = False
# Deal in turn with each video/channel/playlist/folder stored at the
# top level of 'db_dict'
# The 'fake_dbid' is the one used in the database from which the export
# file was generated. Once imported into our database, the new media
# data object will be given a different (real) .dbid
# (In other words, we can't compare this 'fake_dbid' with those used in
# self.media_reg_dict)
for fake_dbid in db_dict.keys():
media_data_obj = None
merge_flag = False
# Each 'mini_dict' contains details for a single video/channel/
# playlist/folder
mini_dict = db_dict[fake_dbid]
# Check whether the user has marked this item to be imported, or
# not
if int(fake_dbid) in flat_db_dict:
check_dict = flat_db_dict[int(fake_dbid)]
if not check_dict['import_flag']:
# Don't import this one
continue
# This item is marked to be imported
if mini_dict['type'] == 'video':
if import_videos_flag:
# Check that a video with the same URL doesn't already
# exist in the parent channel/playlist/folder. If so,
# don't import this duplicate video
if not mini_dict['source'] in url_check_dict:
# This video isn't a duplicate, so we can import it
video_obj = self.add_video(
parent_obj,
mini_dict['source'],
)
if video_obj:
video_count += 1
video_obj.set_name(mini_dict['name'])
video_obj.set_nickname(mini_dict['nickname'])
video_obj.set_vid(mini_dict['vid'])
if mini_dict['file'] is not None:
filename, ext = os.path.splitext(
mini_dict['file'],
)
video_obj.set_file(filename, ext)
else:
if mini_dict['name'] in self.media_name_dict:
# ('old_dbid' is the real .dbid of an item in the media
# data registry)
old_dbid = self.media_name_dict[mini_dict['name']]
old_obj = self.media_reg_dict[old_dbid]
# A channel/playlist/folder with the same name already
# exists in our database. Rename it if the user wants
# that, or if the two have different source URLs
# Exception: 'Unsorted Videos' and 'Video Clips' is always
# merged with itself
if old_obj != self.fixed_misc_folder \
and old_obj != self.fixed_clips_folder \
and (
not merge_duplicates_flag \
or (
not isinstance(old_obj, media.Folder) \
and old_obj.source != mini_dict['source']
)
):
# Rename the imported channel/playlist/folder
mini_dict['name'] = self.rename_imported_container(
mini_dict['name'],
)
mini_dict['nickname'] = self.rename_imported_container(
mini_dict['nickname'],
)
else:
# Use the existing channel/playlist/folder of the same
# name, thereby merging the two
old_dbid = self.media_name_dict[mini_dict['name']]
media_data_obj = self.media_reg_dict[old_dbid]
merge_flag = True
# Import the channel/playlist/folder
if not media_data_obj:
if mini_dict['type'] == 'channel':
media_data_obj = self.add_channel(
mini_dict['name'],
parent_obj,
mini_dict['source'],
)
if media_data_obj:
channel_count += 1
elif mini_dict['type'] == 'playlist':
media_data_obj = self.add_playlist(
mini_dict['name'],
parent_obj,
mini_dict['source'],
)
if media_data_obj:
playlist_count += 1
elif mini_dict['type'] == 'folder':
media_data_obj = self.add_folder(
mini_dict['name'],
parent_obj,
)
if media_data_obj:
folder_count += 1
# If the channel/playlist/folder was successfully imported,
# set its nickname, update the Video Index, then deal with
# any children by calling this function recursively
if media_data_obj is not None:
if not merge_flag:
media_data_obj.set_nickname(mini_dict['nickname'])
self.main_win_obj.video_index_add_row(media_data_obj)
if mini_dict['db_dict']:
(
video_count, channel_count, playlist_count,
folder_count,
) = self.process_import(
mini_dict['db_dict'],
flat_db_dict,
media_data_obj,
import_videos_flag,
merge_duplicates_flag,
selected_is_parent_flag,
video_count,
channel_count,
playlist_count,
folder_count,
)
# Procedure complete
return video_count, channel_count, playlist_count, folder_count
def rename_imported_container(self, name):
"""Called by self.process_import().
When importing a channel/playlist/folder whose name is the same as an
existing channel/playlist/folder, this function is called to rename
the imported one (when necessary).
For example, converts 'Comedy' to 'Comedy (2)'.
Args:
name (str): The name of the imported channel/playlist/folder
Returns:
The converted name
"""
count = 1
while True:
count += 1
new_name = name + ' (' + str(count) + ')'
if not new_name in self.media_name_dict:
return new_name
# (Interact with media data objects)
def watch_video_in_player(self, video_obj):
"""Can be called by anything.
Watch a video using the system's default media player, first checking
that a file actually exists.
Args:
video_obj (media.Video): The video to watch
"""
path = video_obj.get_actual_path(self)
if os.path.isfile(path):
utils.open_file(self, path)
else:
name, ext = os.path.splitext(path)
# Because it's so easy to convert the original video to a different
# format (including audio formats), search for one of those,
# before reporting an error
for test_ext in (formats.VIDEO_FORMAT_LIST):
test_path = name + '.' + test_ext
if os.path.isfile(test_path):
utils.open_file(self, test_path)
return
for test_ext in (formats.AUDIO_FORMAT_LIST):
test_path = name + '.' + test_ext
if os.path.isfile(test_path):
utils.open_file(self, test_path)
return
# Video is completely missing
self.dialogue_manager_obj.show_msg_dialogue(
_(
'The video file is missing from Tartube\'s data folder' \
+ ' (try downloading the video again!)',
),
'error',
'ok',
)
def download_watch_videos(self, video_list, watch_flag=True):
"""Can be called by anything.
Download the specified videos and, when they have been downloaded,
launch them in the system's default media player.
Args:
video_list (list): List of media.Video objects to download and
watch
watch_flag (bool): If False, the video(s) are not launched in the
system's default media player after being downloaded
"""
# Sanity check: this function is only for videos
for video_obj in video_list:
if not isinstance(video_obj, media.Video):
return self.system_error(
171,
'Download and watch video request failed sanity check',
)
# Add the video to the list of videos to be launched in the system's
# default media player, the next time a download operation finishes
if watch_flag:
for video_obj in video_list:
self.watch_after_dl_list.append(video_obj)
if self.download_manager_obj:
# Download operation already in progress. Add these videos to its
# list
for video_obj in video_list:
download_item_obj \
= self.download_manager_obj.download_list_obj.create_item(
video_obj,
None, # media.Scheduled object
'real', # override_operation_type
False, # priority_flag
False, # ignore_limits_flag
)
if download_item_obj:
# Add a row to the Progress List
self.main_win_obj.progress_list_add_row(
download_item_obj.item_id,
video_obj,
)
# Update the main window's progress bar
self.download_manager_obj.nudge_progress_bar()
else:
# Start a new download operation to download this video
self.download_manager_start('real', False, video_list)
# (Custom download manager objects)
def delete_custom_dl_manager(self, custom_dl_obj):
"""Called by callback in
config.SystemPrefWin.on_custom_dl_delete_button_clicked().
Deletes the specified custom download manager object
(downloads.CustomDLManager), which might be applied to the Classic Mode
tab (or not).
Args:
custom_dl_obj (downloads.CustomDLManager): The object to delete
"""
# Sanity check
if self.current_manager_obj \
or self.general_custom_dl_obj == custom_dl_obj:
return self.system_error(
172,
'Delete custom download manager request failed sanity check',
)
# Any media.Scheduled object which references the custom download
# manager must be updated
for scheduled_obj in self.scheduled_list:
if scheduled_obj.custom_dl_uid is not None \
and scheduled_obj.custom_dl_uid == custom_dl_obj.uid:
scheduled_obj.reset_custom_dl_uid()
# Destroy the downloads.CustomDLManager object itself
del self.custom_dl_reg_dict[custom_dl_obj.uid]
if self.classic_custom_dl_obj \
and self.classic_custom_dl_obj == custom_dl_obj:
self.classic_custom_dl_obj = None
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_operations_custom_dl_tab_update_treeview()
# Update the main menu (which lists custom downloads)
self.main_win_obj.update_menu()
def apply_classic_custom_dl_manager(self, custom_dl_obj):
"""Called by
config.SystemPrefWin.on_custom_dl_use_classic_button_clicked().
Applies a specified custom download manager object
(downloads.CustomDLManager) for use in the Classic Mode tab.
Args:
custom_dl_obj (downloads.CustomDLManager): The custom download
manager object to apply
"""
if self.current_manager_obj:
return self.system_error(
173,
'Apply custom download manager request failed sanity check',
)
# Apply the custom download manager
self.classic_custom_dl_obj = custom_dl_obj
# The manager for the Classic Mode tab must do a simulated download
# before a real download
custom_dl_obj.set_dl_precede_flag(True)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_operations_custom_dl_tab_update_treeview()
def disapply_classic_custom_dl_manager(self):
"""Called by
config.SystemPrefWin.on_custom_dl_use_classic_button_clicked().
Disapplies the custom download manager object
(downloads.CustomDLManager) used in the Classic Mode tab, but doesn't
destroy the object.
"""
if self.current_manager_obj or not self.classic_custom_dl_obj:
return self.system_error(
174,
'Disapply custom download manager request failed sanity check',
)
# Disapply the custom download manager
self.classic_custom_dl_obj = None
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_operations_custom_dl_tab_update_treeview()
def create_custom_dl_manager(self, name):
"""Can be called by anything.
Create a new downloads.CustomDLManager object, and updates the IVs
self.custom_dl_reg_count and self.custom_dl_reg_dict.
(It is up to the calling code to update self.general_custom_dl_obj or
self.classic_custom_dl_obj, if required.)
Args:
name (str): A non-unique name for the custom manager
Return values:
Returns the downloads.CustomDLManager object created
"""
self.custom_dl_reg_count += 1
custom_dl_obj = downloads.CustomDLManager(
self.custom_dl_reg_count,
name,
)
self.custom_dl_reg_dict[custom_dl_obj.uid] = custom_dl_obj
# Update the main menu (which lists custom downloads)
self.main_win_obj.update_menu()
return custom_dl_obj
def clone_custom_dl_manager_from_window(self, data_list):
"""Called by config.CustomDLEditWin.on_clone_settings_clicked().
Clones settings from the current custom download manager into the
specified one.
Args:
data_list (list): List of values supplied by the dialogue window.
The first is the edit window for the custom download manager
object (which must be reset). The second value is the custom
download manager object, into which new settings will be
cloned
"""
edit_win_obj = data_list.pop(0)
custom_dl_obj = data_list.pop(0)
# Clone values from the current custom download manager
custom_dl_obj.clone_settings(self.general_custom_dl_obj)
# Reset the edit window to display the new (cloned) values
edit_win_obj.reset_with_new_edit_obj(custom_dl_obj)
def clone_custom_dl_manager(self, old_custom_dl_obj):
"""Can be called by anything.
Clones a custom download manager object, and returns the clone, which
has the same name as the original, but a different .uid.
Args:
old_custom_dl_obj (downloads.CustomDLManager): The object to clone.
Any custom download manager object (including the General
Custom Download Manager) can be cloned
Return values:
The new cloned object
"""
# Work out a name for the clone that's not already in use
# (custom download manager objects don't have unique names, but in this
# case we'll give it a unique name, so that the user can clearly see
# what has happened)
match = re.search('^(.*)\s+(\d+)$', old_custom_dl_obj.name)
if match:
base_name = match.group(1)
index = int(match.group(2))
else:
base_name = old_custom_dl_obj.name
index = 1
match_flag = True
while match_flag:
match_flag = False
index += 1
test_name = base_name + ' ' + str(index)
for this_obj in self.custom_dl_reg_dict.values():
if this_obj.name == test_name:
match_flag = True
break
new_name = base_name + ' ' + str(index)
# Create a new custom download manager object
new_custom_dl_obj = self.create_custom_dl_manager(new_name)
# Copy the original's values into the new object
new_custom_dl_obj.clone_settings(old_custom_dl_obj)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_operations_custom_dl_tab_update_treeview()
# Update the main menu (which lists custom downloads)
self.main_win_obj.update_menu()
return new_custom_dl_obj
def reset_custom_dl_manager(self, data_list):
"""Called by config.CustomDLEditWin.on_reset_settings_clicked().
Resets the specified custom download manager object, setting its IVs to
their default values.
Args:
data_list (list): List of values supplied by the dialogue window,
the first of which is the edit window for the custom download
manager object (which must be reset)
"""
edit_win_obj = data_list.pop(0)
old_custom_dl_obj = edit_win_obj.edit_obj
# Replace the old object with a new one, which has the effect of
# resetting its settings to the default values
new_custom_dl_obj \
= self.create_custom_dl_manager(old_custom_dl_obj.name)
# Update IVs
del self.custom_dl_reg_dict[old_custom_dl_obj.uid]
if self.general_custom_dl_obj == old_custom_dl_obj:
self.general_custom_dl_obj = new_custom_dl_obj
# Reset the edit window to display the new (default) values
edit_win_obj.reset_with_new_edit_obj(new_custom_dl_obj)
# Update the main menu (which lists custom downloads)
self.main_win_obj.update_menu()
def export_custom_dl_manager(self, custom_dl_obj):
"""Called by callback in
config.SystemPrefWin.on_custom_dl_export_button_clicked().
Exports data from the specified downloads.CustomDLManager object as a
JSON file. The data can be-imported (probably when a different
Tartube database is loaded) in a call to
self.import_custom_dl_manager().
Args:
custom_dl_obj (downloads.CustomDLManager): The object whose data
should be exported
"""
# Prompt the user for the file path to use
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select where to save the custom download export'),
self.main_win_obj,
'save',
custom_dl_obj.name + '.json',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Compile a dictionary of data to export. Each key matches an IV in
# the downloads.CustomDLManager object
export_dict = {
'name': custom_dl_obj.name,
'dl_by_video_flag': custom_dl_obj.dl_by_video_flag,
'split_flag': custom_dl_obj.split_flag,
'slice_flag': custom_dl_obj.slice_flag,
'slice_dict': custom_dl_obj.slice_dict.copy(),
'delay_flag': custom_dl_obj.delay_flag,
'delay_max': custom_dl_obj.delay_max,
'delay_min': custom_dl_obj.delay_min,
'divert_mode': custom_dl_obj.divert_mode,
'divert_website': custom_dl_obj.divert_website,
}
# The exported JSON file has the same metadata as a config file, with
# only the 'file_type' being different
# Prepare values
local = utils.get_local_time()
# Prepare a dictionary of data to save as a JSON file
json_dict = {
# Metadata
'script_name': __main__.__packagename__,
'script_version': __main__.__version__,
'save_date': str(local.strftime('%d %b %Y')),
'save_time': str(local.strftime('%H:%M:%S')),
'file_type': 'custom_dl_export',
# Data
'export_dict': export_dict,
}
# Try to save the file
try:
with open(file_path, 'w') as outfile:
json.dump(json_dict, outfile, indent=4)
except Exception as e:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to save the custom download export file:') \
+ '\n\n' + str(e),
'error',
'ok',
)
# Export was successful
self.dialogue_manager_obj.show_msg_dialogue(
_('Custom download exported to:') + '\n\n' + file_path,
'info',
'ok',
)
def import_custom_dl_manager(self, custom_dl_name=None):
"""Called by a callback in
config.SystemPrefWin.on_custom_dl_import_button_clicked().
Imports the contents of a JSON export file generated by a call to
self.export_custom_dl_manager().
Creates a new downloads.CustomDLManager object, and copies the imported
data into it.
Args:
custom_dl_name (str or None): If specified, the new
downloads.CustomDLManager object is given that name. If not
specified, the new object is given the name specified by the
export file
"""
# Prompt the user for the export file to load
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select the custom download export file'),
self.main_win_obj,
'open',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Try to load the export file
json_dict = self.file_manager_obj.load_json(file_path)
if not json_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to load the custom download export file'),
'error',
'ok',
)
# Do some basic checks on the loaded data
# (At the moment, JSON export files are compatible with all
# versions of Tartube after v2.2.0; this may change in future)
if not json_dict \
or not 'script_name' in json_dict \
or not 'script_version' in json_dict \
or not 'save_date' in json_dict \
or not 'save_time' in json_dict \
or not 'file_type' in json_dict \
or json_dict['script_name'] != __main__.__packagename__ \
or json_dict['file_type'] != 'custom_dl_export':
return self.dialogue_manager_obj.show_msg_dialogue(
_('The custom download export file is invalid'),
'error',
'ok',
)
# Retrieve the data itself. export_dict is in the form described in the
# comments in self.export_custom_dl_manager()
export_dict = json_dict['export_dict']
if not export_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('The custom download export file is invalid (or empty)'),
'error',
'ok',
)
# Create a new custom download manager object. If a name was specified
# in the call to this function, use that; otherwise use the name
# specified by the export
if custom_dl_name is None or custom_dl_name == '':
custom_dl_name = export_dict['name']
custom_dl_obj = self.create_custom_dl_manager(custom_dl_name)
# Set the new object's settings
custom_dl_obj.dl_by_video_flag = export_dict['dl_by_video_flag']
custom_dl_obj.split_flag = export_dict['split_flag']
custom_dl_obj.slice_flag = export_dict['slice_flag']
custom_dl_obj.slice_dict = export_dict['slice_dict']
custom_dl_obj.delay_flag = export_dict['delay_flag']
custom_dl_obj.delay_max = export_dict['delay_max']
custom_dl_obj.delay_min = export_dict['delay_min']
custom_dl_obj.divert_mode = export_dict['divert_mode']
custom_dl_obj.divert_website = export_dict['divert_website']
# Show a confirmation
self.dialogue_manager_obj.show_msg_dialogue(
('Imported:') + ' ' + custom_dl_name,
'info',
'ok',
)
def compile_custom_dl_manager_list(self):
"""Can be called by anything.
Returns a list of download.CustomDLManager objects, sorted by name, but
excluding self.general_custom_dl_obj and self.classic_custom_dl_obj.
Return values:
The sorted list (may be empty)
"""
manager_list = []
for this_obj in self.custom_dl_reg_dict.values():
if (
not self.general_custom_dl_obj
or this_obj != self.general_custom_dl_obj
) and (
not self.classic_custom_dl_obj
or this_obj != self.classic_custom_dl_obj
):
manager_list.append(this_obj)
# (Sort alphabetically by name)
def get_name(obj):
return obj.name
manager_list.sort(key=get_name)
return manager_list
# (Profiles)
def add_profile(self, profile_name, dbid_list):
"""Called by self.on_menu_create_profile().
Creates a profile.
Args:
profile_name (str): A name for the new profile
dbid_list (list): A list of .dbids for media.Channel,
media.Playlist and media.Folder objects. When this profile is
active, all of those items are marked for download
"""
if profile_name in self.profile_dict:
return self.app_obj.system_error(
175,
'Duplicate profile name \'{1}\''.format(profile_name),
)
elif len(self.profile_dict) >= self.profile_max:
return self.app_obj.system_error(
176,
'Number of profiles exceeds maximum',
)
self.profile_dict[profile_name] = dbid_list
self.last_profile = profile_name
# Update the main menu (which lists profiles)
self.main_win_obj.update_menu()
def delete_profile(self, profile_name):
"""Called by mainwin.MainWin.on_delete_profile_menu_select().
Deletes the specified profile.
Args:
profile_name (str): A key in self.profile_dict
"""
if not profile_name in self.profile_dict:
return self.app_obj.system_error(
177,
'Unrecognised profile \'{1}\''.format(profile_name),
)
del self.profile_dict[profile_name]
if self.last_profile == profile_name:
self.last_profile = None
# Update the main menu (which lists profiles)
self.main_win_obj.update_menu()
# (Download options manager objects)
def apply_download_options(self, media_data_obj, options_obj=None):
"""Can be called by anything.
Applies a download options object (options.OptionsManager) to a media
data object, and also to any of its descendants (unless they too have
an applied download options object).
The download options are passed to youtube-dl during a download
operation.
Args:
media_data_obj (media.Video, media.Channel, media.Playlist or
media.Folder): The media data object to which the download
options are applied
options_obj (options.OptionsManager or None): The download options
to apply, which must not have been applied to any other media
data object, and must not be the General Options Manager. If
not specified, a new download options object is created
"""
if self.current_manager_obj \
or media_data_obj.options_obj\
or (
isinstance(media_data_obj, media.Folder)
and media_data_obj.priv_flag
) \
or (
options_obj \
and (
options_obj == self.general_options_obj \
or options_obj.dbid
)
):
return self.system_error(
178,
'Apply download options request failed sanity check',
)
# Create a new options manager, if none was specified
if not options_obj:
options_obj = self.create_download_options(
media_data_obj.name,
media_data_obj.dbid,
)
# If required, clone download options from the General Options
# Manager into this new download options manager
if self.auto_clone_options_flag:
options_obj.clone_options(
self.general_options_obj,
)
# Apply download options to the specified media data object
media_data_obj.set_options_obj(options_obj)
media_data_obj.options_obj.set_dbid(media_data_obj.dbid)
# Update the Video Index or Video Catalogue, as required
if isinstance(media_data_obj, media.Video):
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
media_data_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
def remove_download_options(self, media_data_obj):
"""Can be called by anything.
Removes a download options object (options.OptionsManager) from a media
data object, an action which also affects its descendants (unless they
too have an applied download options object).
Note that when a media data object is deleted, self.delete_video() or
self.delete_container_complete() updates the options object without
calling this function.
Args:
media_data_obj (media.Video, media.Channel, media.Playlist or
media.Folder): The media data object from which the download
options are removed.
"""
# Sanity check. Removing an options manager object during an operation
# is not allowed, with one exception: during a download operation,
# a video marked as downloaded can have its options manager removed
if not (
self.download_manager_obj \
and isinstance(media_data_obj, media.Video) \
and media_data_obj.dl_flag
):
if self.current_manager_obj or not media_data_obj.options_obj:
return self.system_error(
179,
'Remove download options request failed sanity check',
)
# Destroy the options.OptionsManager object itself
if media_data_obj.options_obj is not None:
uid = media_data_obj.options_obj.uid
del self.options_reg_dict[uid]
else:
uid = None
# Remove download options from the media data object
media_data_obj.reset_options_obj()
# Update the row in the Video Index or Video Catalogue
if isinstance(media_data_obj, media.Video):
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
media_data_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
# Remove any associated dropzone, and update the Drag and Drop tab
if uid in self.classic_dropzone_list:
self.classic_dropzone_list.remove(uid)
self.main_win_obj.drag_drop_grid_reset()
def delete_download_options(self, options_obj):
"""Called by callback in
config.SystemPrefWin.on_options_delete_button_clicked().
Deletes the specified download options object (options.OptionsManager),
which might be applied to a media data object (or not), and might be
applied to the Classic Mode tab (or not).
If it's applied to a media data object, its descendants are also
affected (unless they too have an applied download options object).
Args:
options_obj (options.OptionsManager): The object to delete
"""
# Sanity check
if self.current_manager_obj \
or self.general_options_obj == options_obj:
return self.system_error(
180,
'Delete download options request failed sanity check',
)
media_data_obj = None
if options_obj.dbid and options_obj.dbid in self.media_reg_dict:
media_data_obj = self.media_reg_dict[options_obj.dbid]
# Destroy the options.OptionsManager object itself
del self.options_reg_dict[options_obj.uid]
if self.classic_options_obj \
and self.classic_options_obj == options_obj:
self.classic_options_obj = None
if media_data_obj:
# Remove download options from the media data object
media_data_obj.reset_options_obj()
# Update the row in the Video Index or Video Catalogue
if isinstance(media_data_obj, media.Video):
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
media_data_obj,
)
else:
GObject.timeout_add(
0,
self.main_win_obj.video_index_update_row_icon,
media_data_obj,
)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
# Remove any associated dropzone, and update the Drag and Drop tab
if options_obj.uid in self.classic_dropzone_list:
self.classic_dropzone_list.remove(options_obj.uid)
self.main_win_obj.drag_drop_grid_reset()
def apply_classic_download_options(self, options_obj):
"""Called by
config.SystemPrefWin.on_options_use_classic_button_clicked().
A modified version of self.apply_download_options.
Applies a specified download options object (options.OptionsManager)
for use in the Classic Mode tab.
Args:
options_obj (options.OptionsManager): The download options object
to apply
"""
if self.current_manager_obj:
return self.system_error(
181,
'Apply download options request failed sanity check',
)
# Apply download options
self.classic_options_obj = options_obj
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
def disapply_classic_download_options(self):
"""Called by mainwin.MainWin.on_classic_menu_use_general_options()
and config.SystemPrefWin.on_options_use_classic_button_clicked().
Disapplies the download options object (options.OptionsManager) used
in the Classic Mode tab, but doesn't destroy the object.
"""
if self.current_manager_obj or not self.classic_options_obj:
return self.system_error(
182,
'Disapply download options request failed sanity check',
)
# Disapply download options
self.classic_options_obj = None
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
def create_download_options(self, name, dbid=None):
"""Can be called by anything.
Create a new options.OptionsManager object, and updates the IVs
self.options_reg_count and self.options_reg_dict.
(It is up to the calling code to update self.general_options_obj or
self.classic_options_obj, if required.)
Args:
name (str): A non-unique name for the options manager
dbid (int or None): If specified, the .dbid of the media.Video,
media.Channel, media.Playlist or media.Folder to which these
options are attached
Return values:
Returns the options.OptionsManager object created
"""
self.options_reg_count += 1
options_obj = options.OptionsManager(
self.options_reg_count,
name,
dbid,
)
self.options_reg_dict[options_obj.uid] = options_obj
return options_obj
def clone_download_options_from_window(self, data_list):
"""Called by config.OptionsEditWin.on_clone_options_clicked().
(Not called by self.apply_download_options(), which can handle its own
cloning).
Clones youtube-dl download options from the General Options manager
into the specified download options manager.
This function is designed to be called from one particular place. For
general cloning, call self.clone_download_options() instead.
Args:
data_list (list): List of values supplied by the dialogue window.
The first is the edit window for the download options object
(which must be reset). The second value is the download options
manager object, into which new options will be cloned.
"""
edit_win_obj = data_list.pop(0)
options_obj = data_list.pop(0)
# Clone values from the general download options manager
options_obj.clone_options(self.general_options_obj)
# Reset the edit window to display the new (cloned) values
edit_win_obj.reset_with_new_edit_obj(options_obj)
def clone_download_options(self, old_options_obj):
"""Can be called by anything.
Clones an options manager object, and returns the clone, which has the
same name as the original, but a different .uid.
Args:
old_options_obj (options.OptionsManager): The object to clone. Any
options manager object (including the General Options Manager)
can be cloned
Return values:
The new cloned object
"""
# Work out a name for the clone that's not already in use (either by
# an existing options manager, or by a channel/playlist/folder)
# (Options manager objects don't have unique names, but in this case
# we'll give it a unique name, so that the user can clearly see what
# has happened)
match = re.search('^(.*)\s+(\d+)$', old_options_obj.name)
if match:
base_name = match.group(1)
index = int(match.group(2))
else:
base_name = old_options_obj.name
index = 1
match_flag = True
while match_flag:
match_flag = False
index += 1
test_name = base_name + ' ' + str(index)
if not test_name in self.media_name_dict:
for this_obj in self.options_reg_dict.values():
if this_obj.name == test_name:
match_flag = True
break
new_name = base_name + ' ' + str(index)
# Create a new options object, with the same name as the original
new_options_obj = self.create_download_options(new_name)
# Copy the original's values into the new object
new_options_obj.clone_options(old_options_obj)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
return new_options_obj
def reset_download_options(self, data_list):
"""Called by config.OptionsEditWin.on_reset_options_clicked().
Resets the specified download options manager object, setting its
options to their default values.
Args:
data_list (list): List of values supplied by the dialogue window,
the first of which is the edit window for the download options
object (which must be reset)
"""
edit_win_obj = data_list.pop(0)
old_options_obj = edit_win_obj.edit_obj
# Replace the old object with a new one, which has the effect of
# resetting its download options to the default values
new_options_obj = self.create_download_options(
old_options_obj.name,
old_options_obj.dbid,
)
# Update IVs
del self.options_reg_dict[old_options_obj.uid]
if self.general_options_obj == old_options_obj:
self.general_options_obj = new_options_obj
elif self.classic_options_obj == old_options_obj:
self.classic_options_obj = new_options_obj
mod_list = []
for uid in self.classic_dropzone_list:
if uid == old_options_obj.uid:
mod_list.append(new_options_obj.uid)
else:
mod_list.append(uid)
self.classic_dropzone_list = mod_list
if old_options_obj.dbid is not None:
media_data_obj = self.media_reg_dict[old_options_obj.dbid]
media_data_obj.set_options_obj(new_options_obj)
# Reset the edit window to display the new (default) values
edit_win_obj.reset_with_new_edit_obj(new_options_obj)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_dl_list_tab_update_treeview()
# Update the Drag and Drop tab
self.main_win_obj.drag_drop_grid_reset()
def export_download_options(self, options_obj):
"""Called by callback in
config.SystemPrefWin.on_options_export_button_clicked().
Exports data from the specified options.OptionsManager object as a
JSON file. The data can be-imported (probably when a different
Tartube database is loaded) in a call to
self.import_download_options().
Args:
options_obj (options.OptionsManager): The object whose data should
be exported
"""
# Prompt the user for the file path to use
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select where to save the options export'),
self.main_win_obj,
'save',
options_obj.name + '.json',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Compile a dictionary of data to export. Each key matches an IV in
# the options.OptionsManager object
export_dict = {
'name': options_obj.name,
'options_dict': options_obj.options_dict.copy(),
}
# The exported JSON file has the same metadata as a config file, with
# only the 'file_type' being different
# Prepare values
local = utils.get_local_time()
# Prepare a dictionary of data to save as a JSON file
json_dict = {
# Metadata
'script_name': __main__.__packagename__,
'script_version': __main__.__version__,
'save_date': str(local.strftime('%d %b %Y')),
'save_time': str(local.strftime('%H:%M:%S')),
'file_type': 'options_export',
# Data
'export_dict': export_dict,
}
# Try to save the file
try:
with open(file_path, 'w') as outfile:
json.dump(json_dict, outfile, indent=4)
except Exception as e:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to save the options export file:') \
+ '\n\n' + str(e),
'error',
'ok',
)
# Export was successful
self.dialogue_manager_obj.show_msg_dialogue(
_('Download options exported to to:') + '\n\n' + file_path,
'info',
'ok',
)
def import_download_options(self, options_name=None):
"""Called by a callback in
config.SystemPrefWin.on_options_import_button_clicked().
Imports the contents of a JSON export file generated by a call to
self.export_download_options().
Creates a new options.OptionsManager object, and copies the imported
data into it.
Args:
options_name (str or None): If specified, the new
options.OptionsManager object is given that name. If not
specified, the new object is given the name specified by the
export file
"""
# Prompt the user for the export file to load
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select the options export file'),
self.main_win_obj,
'open',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Try to load the export file
json_dict = self.file_manager_obj.load_json(file_path)
if not json_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to load the options export file'),
'error',
'ok',
)
# Do some basic checks on the loaded data
# (At the moment, JSON export files are compatible with all
# versions of Tartube after v2.2.0; this may change in future)
if not json_dict \
or not 'script_name' in json_dict \
or not 'script_version' in json_dict \
or not 'save_date' in json_dict \
or not 'save_time' in json_dict \
or not 'file_type' in json_dict \
or json_dict['script_name'] != __main__.__packagename__ \
or json_dict['file_type'] != 'options_export':
return self.dialogue_manager_obj.show_msg_dialogue(
_('The options export file is invalid'),
'error',
'ok',
)
# Retrieve the data itself. export_dict is in the form described in the
# comments in self.export_download_options()
export_dict = json_dict['export_dict']
if not export_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('The options export file is invalid (or empty)'),
'error',
'ok',
)
# Create a new options object. If a name was specified in the call to
# this function, use that; otherwise use the name specified by the
# export
if options_name is None or options_name == '':
options_name = export_dict['name']
options_obj = self.create_download_options(options_name)
# Set the new object's options. To guard against future code updates,
# do it one key at a time
options_dict = export_dict['options_dict']
for key in options_dict.keys():
value = options_dict[key]
if key in options_obj.options_dict:
options_obj.options_dict[key] = options_dict[key]
# Show a confirmation
self.dialogue_manager_obj.show_msg_dialogue(
('Imported:') + ' ' + options_name,
'info',
'ok',
)
# (FFmpeg options manager objects)
def create_ffmpeg_options(self, name):
"""Can be called by anything.
Create a new ffmpeg_tartube.FFmpegOptionsManager object, and updates
the IVs self.ffmpeg_reg_count and self.ffmpeg_reg_dict.
(It is up to the calling code to update self.ffmpeg_options_obj, if
required.)
Args:
name (str): A non-unique name for the options manager
Return values:
Returns the options.OptionsManager object created
"""
self.ffmpeg_reg_count += 1
options_obj = ffmpeg_tartube.FFmpegOptionsManager(
self.ffmpeg_reg_count,
name,
)
self.ffmpeg_reg_dict[options_obj.uid] = options_obj
return options_obj
def clone_ffmpeg_options_from_window(self, data_list):
"""Called by config.FFmpegOptionsEditWin.on_clone_options_clicked().
Clones FFmpeg download options from the current FFmpeg options manager
into the specified one.
Args:
data_list (list): List of values supplied by the dialogue window.
The first is the edit window for the FFmpeg options object
(which must be reset). The second value is the FFmpeg options
manager object, into which new options will be cloned.
"""
edit_win_obj = data_list.pop(0)
options_obj = data_list.pop(0)
# Clone values from the current FFmpeg options manager
options_obj.clone_options(self.ffmpeg_options_obj)
# Reset the edit window to display the new (cloned) values
edit_win_obj.reset_with_new_edit_obj(options_obj)
def clone_ffmpeg_options(self, old_options_obj):
"""Can be called by anything.
Clones an FFmpeg manager object, and returns the clone, which has the
same name as the original, but a different .uid.
Args:
old_options_obj (ffmpeg_tartube.FFmpegOptionsManager): The object
to clone. Any options manager object (including the current
one) can be cloned
Return values:
The new cloned object
"""
# Work out a name for the clone that's not already in use
# (FFmpeg Options manager objects don't have unique names, but in this
# case we'll give it a unique name, so that the user can clearly see
# what has happened)
match = re.search('^(.*)\s+(\d+)$', old_options_obj.name)
if match:
base_name = match.group(1)
index = int(match.group(2))
else:
base_name = old_options_obj.name
index = 1
match_flag = True
while match_flag:
match_flag = False
index += 1
test_name = base_name + ' ' + str(index)
for this_obj in self.ffmpeg_reg_dict.values():
if this_obj.name == test_name:
match_flag = True
break
new_name = base_name + ' ' + str(index)
# Create a new options object
new_options_obj = self.create_ffmpeg_options(new_name)
# Copy the original's values into the new object
new_options_obj.clone_options(old_options_obj)
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_ffmpeg_list_tab_update_treeview()
return new_options_obj
def reset_ffmpeg_options(self, data_list):
"""Called by config.FFmpegOptionsEditWin.on_reset_options_clicked().
Resets the specified FFmpeg options manager object, setting its options
to their default values.
Args:
data_list (list): List of values supplied by the dialogue window,
the first of which is the edit window for the download options
object (which must be reset)
"""
edit_win_obj = data_list.pop(0)
old_options_obj = edit_win_obj.edit_obj
# Replace the old object with a new one, which has the effect of
# resetting its FFmpeg options to the default values
new_options_obj = self.create_ffmpeg_options(old_options_obj.name)
# Update IVs
del self.ffmpeg_reg_dict[old_options_obj.uid]
if self.ffmpeg_options_obj == old_options_obj:
self.ffmpeg_options_obj = new_options_obj
# Reset the edit window to display the new (default) values
edit_win_obj.reset_with_new_edit_obj(new_options_obj)
def delete_ffmpeg_options(self, options_obj):
"""Called by callback in
config.SystemPrefWin.on_ffmpeg_delete_button_clicked().
Deletes the specified FFmpeg options object
(ffmpeg_tartube.FFmpegOptionsManager).
Args:
options_obj (ffmpeg_tartube.FFmpegOptionsManager): The object to
delete
"""
# Sanity check
if self.ffmpeg_options_obj == options_obj:
return self.system_error(
183,
'Delete FFmpeg options request failed sanity check',
)
# Destroy the ffmpeg_tartube.FFmpegOptionsManager object itself
del self.ffmpeg_reg_dict[options_obj.uid]
# Update the list in any preference windows that are open
for config_win_obj in self.main_win_obj.config_win_list:
if isinstance(config_win_obj, config.SystemPrefWin):
config_win_obj.setup_options_ffmpeg_list_tab_update_treeview()
def export_ffmpeg_options(self, options_obj):
"""Called by callback in
config.SystemPrefWin.on_ffmpeg_export_button_clicked().
Exports data from the specified ffmpeg_tartube.FFmpegOptionsManager
object as a JSON file. The data can be-imported (probably when a
different Tartube database is loaded) in a call to
self.import_ffmpeg_options().
Args:
options_obj (ffmpeg_tartube.FFmpegOptionsManager): The object whose
data should be exported.
"""
# Prompt the user for the file path to use
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select where to save the options export'),
self.main_win_obj,
'save',
options_obj.name + '.json',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Compile a dictionary of data to export. Each key matches an IV in
# the ffmpeg_tartube.FFmpegOptionsManager object
export_dict = {
'name': options_obj.name,
'options_dict': options_obj.options_dict.copy(),
}
# The exported JSON file has the same metadata as a config file, with
# only the 'file_type' being different
# Prepare values
local = utils.get_local_time()
# Prepare a dictionary of data to save as a JSON file
json_dict = {
# Metadata
'script_name': __main__.__packagename__,
'script_version': __main__.__version__,
'save_date': str(local.strftime('%d %b %Y')),
'save_time': str(local.strftime('%H:%M:%S')),
'file_type': 'ffmpeg_export',
# Data
'export_dict': export_dict,
}
# Try to save the file
try:
with open(file_path, 'w') as outfile:
json.dump(json_dict, outfile, indent=4)
except Exception as e:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to save the options export file:') \
+ '\n\n' + str(e),
'error',
'ok',
)
# Export was successful
self.dialogue_manager_obj.show_msg_dialogue(
_('FFmpeg options exported to to:') + '\n\n' + file_path,
'info',
'ok',
)
def import_ffmpeg_options(self, options_name=None):
"""Called by a callback in
config.SystemPrefWin.on_ffmpeg_import_button_clicked().
Imports the contents of a JSON export file generated by a call to
self.export_ffmpeg_options().
Creates a new ffmpeg_tartube.FFmpegOptionsManager object, and copies
the imported data into it.
Args:
options_name (str or None): If specified, the new
ffmpeg_tartube.FFmpegOptionsManager object is given that name.
If not specified, the new object is given the name specified by
the export file
"""
# Prompt the user for the export file to load
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Select the options export file'),
self.main_win_obj,
'open',
)
response = dialogue_win.run()
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
return
file_path = dialogue_win.get_filename()
dialogue_win.destroy()
if not file_path:
return
# Try to load the export file
json_dict = self.file_manager_obj.load_json(file_path)
if not json_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('Failed to load the options export file'),
'error',
'ok',
)
# Do some basic checks on the loaded data
# (At the moment, JSON export files are compatible with all
# versions of Tartube after v2.2.0; this may change in future)
if not json_dict \
or not 'script_name' in json_dict \
or not 'script_version' in json_dict \
or not 'save_date' in json_dict \
or not 'save_time' in json_dict \
or not 'file_type' in json_dict \
or json_dict['script_name'] != __main__.__packagename__ \
or json_dict['file_type'] != 'ffmpeg_export':
return self.dialogue_manager_obj.show_msg_dialogue(
_('The options export file is invalid'),
'error',
'ok',
)
# Retrieve the data itself. export_dict is in the form described in the
# comments in self.export_ffmpeg_options()
export_dict = json_dict['export_dict']
if not export_dict:
return self.dialogue_manager_obj.show_msg_dialogue(
_('The options export file is invalid (or empty)'),
'error',
'ok',
)
# Create a new options object. If a name was specified in the call to
# this function, use that; otherwise use the name specified by the
# export
if options_name is None or options_name == '':
options_name = export_dict['name']
options_obj = self.create_ffmpeg_options(options_name)
# Set the new object's options. To guard against future code updates,
# do it one key at a time
options_dict = export_dict['options_dict']
for key in options_dict.keys():
value = options_dict[key]
if key in options_obj.options_dict:
options_obj.options_dict[key] = options_dict[key]
# Show a confirmation
self.dialogue_manager_obj.show_msg_dialogue(
('Imported:') + ' ' + options_name,
'info',
'ok',
)
# (Sound effects)
def play_sound(self, sound_name=None):
"""Can be called by anything.
Plays the specified sound effect.
Args:
sound_name (str): The sound effect to play, one of the items in
self.sound_list. If no sound effect is specified, plays the
user's chosen sound effect, self.sound_custom
"""
if sound_name is None:
sound_name = self.sound_custom
path = os.path.abspath(
os.path.join(self.sound_dir, sound_name),
)
if os.path.isfile(path) and HAVE_PLAYSOUND_FLAG:
# v2.1.025 - on a system on which the playsound module is not
# installed, I'm seeing (very rarely) a 'name 'playsound' is not
# defined' error
# Cannot reproduce the problem, so enclose this code in a try block
# to prevent the error
try:
playsound.playsound(path)
except:
self.system_error(
184,
'System tried to play sound effect, even though Python' \
+ ' playsound module was not detected',
)
# Callback class methods
# (Timers)
def script_slow_timer_callback(self):
"""Called by one of the GObject timers created by self.start().
A few times every minute, check whether it's time to perform a
scheduled download and, if so, perform it.
Otherwise, check whether it's time to perform a scheduled livestream
operation and, if so, perform it.
Returns:
1 to keep the timer going, or None to halt it
"""
# No point keeping the timer going, once load/save (and therefore all
# operations) are disabled
if self.disable_load_save_flag:
return None
# Scheduled downloads do not take place after a failed call to
# self.save_db(), but can resume on a successful call to that
# function, or a successful call to self.load_db()
if self.disable_scheduled_dl_flag:
# Return 1 to keep the timer going (or 0 to halt the once-only
# timer)
return self.script_slow_timer_get_return_value()
# Depending on settings, one or several scheduled downloads may be
# started at the same time
# Compile a list of media.Scheduled objects, each one representing a
# scheduled download that is due to start now
first_list = []
next_list = []
all_obj = False
shutdown_flag = False
ignore_limits_flag = False
no_join_flag = False
for scheduled_obj in self.scheduled_list:
if scheduled_obj.check_start() \
and (
not self.download_manager_obj \
or scheduled_obj.join_mode != 'skip'
):
if scheduled_obj.exclusive_flag \
or (
scheduled_obj.dl_mode == 'custom_real' \
and scheduled_obj.custom_dl_uid is not None
):
# Only perform this scheduled download
first_list = [scheduled_obj]
next_list = []
shutdown_flag = scheduled_obj.shutdown_flag
ignore_limits_flag = scheduled_obj.ignore_limits_flag
if scheduled_obj.all_flag:
all_obj = scheduled_obj
if scheduled_obj.dl_mode == 'custom_real' \
and scheduled_obj.custom_dl_uid is not None:
no_join_flag = True
break
# 'start'/'start_after' should be done before 'repeat' and
# 'timetable'
if scheduled_obj.start_mode == 'start' \
or scheduled_obj.start_mode == 'start_after':
first_list.append(scheduled_obj)
else:
next_list.append(scheduled_obj)
if scheduled_obj.shutdown_flag:
shutdown_flag = True
if scheduled_obj.ignore_limits_flag:
ignore_limits_flag = True
if scheduled_obj.all_flag:
all_obj = scheduled_obj
break
start_list = first_list + next_list
# In case there are different values for media.Scheduled.dl_mode and
# media.Scheduled.join_mode, then a custom download takes priority
# over a real download, which takes priority over a simulated
# download
dl_mode = None
for scheduled_obj in start_list:
if dl_mode is None \
or (dl_mode == 'sim' and scheduled_obj.dl_mode != 'sim') \
or (
dl_mode == 'real'
and scheduled_obj.dl_mode == 'custom_real'
):
dl_mode = scheduled_obj.dl_mode
join_mode = scheduled_obj.join_mode
# If any scheduled downloads are due to start, and any of the
# media.Scheduled objects have their .all_flag IV set, then we simply
# download everything
if start_list and all_obj and dl_mode is not None:
# Download everything
# If no download operation is in progress, start one (if we're
# allowed to)
if not self.download_manager_obj \
and not self.current_manager_obj \
and not self.main_win_obj.config_win_list:
self.download_manager_start(
dl_mode,
True, # This function is the calling function
[all_obj], # Make sure performance limits respected
)
# Ignore operation limits, if required
if ignore_limits_flag:
self.download_manager_obj.apply_ignore_limits()
# Shutdown Tartube after this d/l operation, if required
if self.download_manager_obj and shutdown_flag:
self.halt_after_operation_flag = True
# Set the next download time for each scheduled download
self.script_slow_timer_reset_scheduled_dl(start_list)
# Return 1 to keep the timer going (or 0 to halt the once-only
# timer)
return self.script_slow_timer_get_return_value()
# Otherwise, add all media data objects in the top-level list (all
# children are downloaded too)
elif self.download_manager_obj and join_mode != 'skip':
for dbid in self.media_top_level_list:
media_data_obj = self.media_reg_dict[dbid]
# (Don't try to download the 'All Videos' folder, etc)
if not isinstance(media_data_obj. media.Folder) \
or not media_data_obj.priv_flag:
self.script_slow_timer_insert_download(
media_data_obj,
all_obj,
dl_mode,
join_mode,
ignore_limits_flag,
)
# Shutdown Tartube after this d/l operation, if required
if shutdown_flag:
self.halt_after_operation_flag = True
# Set the next download time for each scheduled download
self.script_slow_timer_reset_scheduled_dl(start_list)
# Return 1 to keep the timer going (or 0 to halt the once-only
# timer)
return self.script_slow_timer_get_return_value()
# If any scheduled downloads are still due to start, and a download
# operation is already in progress, then we can simpy add new media
# data objects to it
if start_list and self.download_manager_obj and not no_join_flag:
for scheduled_obj in start_list:
for name in scheduled_obj.media_list:
if not name in self.media_name_dict:
self.system_error(
185,
'Scheduled download contains a channel, playlist' \
+ ' or folder which no longer exists: \'' \
+ name + '\'',
)
else:
dbid = self.media_name_dict[name]
media_data_obj = self.media_reg_dict[dbid]
self.script_slow_timer_insert_download(
media_data_obj,
scheduled_obj,
scheduled_obj.dl_mode,
scheduled_obj.join_mode,
scheduled_obj.ignore_limits_flag,
)
# Shutdown Tartube after this d/l operation, if required
if shutdown_flag:
self.halt_after_operation_flag = True
# Set the next download time for each scheduled download
self.script_slow_timer_reset_scheduled_dl(start_list)
# Return 1 to keep the timer going (or 0 to halt the once-only
# timer)
return self.script_slow_timer_get_return_value()
# If any scheduled downloads are still to start, and no download
# operation is already in progress, start one (if we're allowed to)
if start_list \
and not self.download_manager_obj \
and not self.current_manager_obj \
and not self.main_win_obj.config_win_list:
# Pass the list of media.Scheduled objects directly to the download
# manager, since each object might have different values for
# their .dl_mode and .join_mode IVs
self.download_manager_start(
# In this case, the default operation type does not matter, but
# it's still nice to display 'Checking...' in the Videos tab
# label, if we're only doing simulated downloads
dl_mode,
True, # This function is the calling function
start_list,
)
# Shutdown Tartube after this d/l operation, if required
if self.download_manager_obj and shutdown_flag:
self.halt_after_operation_flag = True
# Set the next download time for each scheduled download
self.script_slow_timer_reset_scheduled_dl(start_list)
# Return 1 to keep the timer going (or 0 to halt the once-only
# timer)
return self.script_slow_timer_get_return_value()
# Otherwise, we're free to start a livestream operation instead (but
# only if there is at least one media.Video object marked as a
# livestream)
if self.scheduled_livestream_flag and self.media_reg_live_dict:
start_flag = False
wait_time = self.scheduled_livestream_wait_mins * 60
if (self.scheduled_livestream_last_time + wait_time) < time.time():
start_flag = True
# If any livestreams are due to start soon, start a livestream
# operation once a minute (if allowed)
elif self.scheduled_livestream_extra_flag \
and (self.scheduled_livestream_last_time + 60) < time.time():
for video_obj in self.media_reg_live_dict.values():
if video_obj.live_mode == 1 \
and (video_obj.live_time - wait_time) < time.time():
start_flag = True
break
if start_flag:
self.livestream_manager_start()
# Return 1 to keep the timer going (or 0 to halt the once-only timer)
return self.script_slow_timer_get_return_value()
def script_slow_timer_get_return_value(self):
"""Called by self.script_slow_timer_callback().
Provides a return value for the calling function: 1 to keep the
GObject timer going, or 0 to halt it.
"""
if self.script_once_timer_id is not None:
# Halt the once-only timer
self.script_once_timer_id = None
return 0
else:
# The slow timer keeps going indefinitely
return 1
def script_slow_timer_insert_download(self, media_data_obj, scheduled_obj,
dl_mode, join_mode, ignore_limits_flag):
"""Called by self.script_slow_timer_callback(), when a download
operation is already in progress.
Adds a new download item to the download list.
Args:
media_data_obj (media.Channel, media.Playlist, media.Folder): The
media data object to add. It, as well as all of its children,
are added to the download queue
scheduled_obj (media.Scheduled): The scheduled download object
which wants to download media_data_obj (None if no scheduled
download applies in this case)
dl_mode (str): 'sim', 'real' or 'multi', matching the value of
downloads.DownloadManager.operation_type
join_mode (str): 'join', 'priority' or 'skip', matching the value
of media.Scheduled.join_mode
ignore_limits_flag (bool): True if operation limits
(self.operation_limit_flag) should be ignored
"""
if self.download_manager_obj:
if join_mode == 'priority':
priority_flag = True
else:
priority_flag = False
download_item_obj \
= self.download_manager_obj.download_list_obj.create_item(
media_data_obj,
scheduled_obj,
dl_mode,
priority_flag,
ignore_limits_flag,
)
if download_item_obj:
# Add a row to the Progress List
self.main_win_obj.progress_list_add_row(
download_item_obj.item_id,
media_data_obj,
)
# Update the main window's progress bar
self.download_manager_obj.nudge_progress_bar()
def script_slow_timer_reset_scheduled_dl(self, scheduled_list):
"""Called by self.script_slow_timer_callback().
Given a list of media.Scheduled object(s)s which have just been
started, set the time at which the next scheduled download(s) should
start.
Args:
scheduled_list (list): A list of media.Scheduled objects
"""
current_time = time.time()
for scheduled_obj in scheduled_list:
scheduled_obj.set_last_time(current_time)
scheduled_obj.set_only_time(0)
def script_fast_timer_callback(self):
"""Called by GObject timer created by self.start().
Several times a second, check whether there are any mainwin.Catalogue
objects to add to the Video Catalogue and, if so, adds them.
Resets the position of main window sliders, if that is due to happen.
Optionally checks the number of columns that can fit in the available
space of the Video Catalogue grid (when visible), and increase/
reduces the size of the grid, if necessary.
Resets any confirmation messages in the Drag and Drop tab.
Returns:
1 to keep the timer going, or None to halt it
"""
# Reset the position of main window sliders (due to Gtk issues, for a
# second time), if required
if self.main_win_slider_reset_flag:
self.main_win_slider_reset_flag = False
self.main_win_obj.reset_sliders()
# Update the Video Catalogue, increasing/decreasing the number of
# columns in the grid (if visible, and if necessary)
# This happens after the minimum required width of a gridbox is
# established
if self.main_win_obj.catalogue_grid_rearrange_flag:
self.main_win_obj.video_catalogue_grid_check_size()
# If a list of videos, rather than a grid, is visible, then insert any
# rows that were to be inserted, but which could not be a few moments
# ago
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_retry_insert_items,
)
# Reset confirmation messages in the Drag and Drop tab, if it's time
# to reset them
for wrapper_obj in self.main_win_obj.drag_drop_dict.values():
wrapper_obj.check_reset()
# Return 1 to keep the timer going
return 1
def dl_timer_callback(self):
"""Called by GObject timer created by self.download_manager_continue().
During a download operation, a GObject timer runs, so that the Progress
tab and Output tab can be updated at regular intervals. (When the
download operation is launched from the Classic Mode tab, the
Classic Progress List and Output tab are updated.)
There is also a delay between the instant at which youtube-dl reports a
video file has been downloaded, and the instant at which it appears in
the filesystem. The timer checks for newly-existing files at regular
intervals, too.
If required, this function periodically checks whether the device
containing self.data_dir is running out of space (and halts the
operation, if so.)
Returns:
1 to keep the timer going, or None to halt it
"""
# This function behaves differently, if the download operation was
# launched from the Classic Mode tab
if not self.download_manager_obj \
or not self.download_manager_obj.operation_classic_flag:
classic_mode_flag = False
else:
classic_mode_flag = True
# Update the disk space visible in the Videos tab
disk_space = utils.disk_get_free_space(self.data_dir)
if self.download_manager_obj:
self.main_win_obj.update_free_space_msg(disk_space)
# Periodically check (if required) whether the device is running out of
# disk space
if self.dl_timer_disk_space_check_time is None:
# First check occurs 60 seconds after the operation begins
self.dl_timer_disk_space_check_time \
= time.time() + self.dl_timer_disk_space_time
elif self.dl_timer_disk_space_check_time < time.time():
self.dl_timer_disk_space_check_time \
= time.time() + self.dl_timer_disk_space_time
if (
self.disk_space_stop_flag \
and self.disk_space_stop_limit != 0 \
and disk_space <= self.disk_space_stop_limit
) or disk_space < self.disk_space_abs_limit:
# Stop the download operation
self.system_error(
186,
'Download operation halted because the device is running' \
+ ' out of space',
)
self.download_manager_obj.stop_download_operation()
# Return 1 to keep the timer going, which allows the operation
# to finish naturally
return 1
# Disk space check complete, now update main window widgets
check_time = self.dl_timer_check_time
if check_time is None or check_time > time.time():
if not classic_mode_flag:
self.main_win_obj.progress_list_display_dl_stats()
self.main_win_obj.results_list_update_row()
else:
self.main_win_obj.classic_mode_tab_display_dl_stats()
if not classic_mode_flag and self.progress_list_hide_flag:
self.main_win_obj.progress_list_check_hide_rows()
if check_time is None:
# Download operation still in progress, return 1 to keep the
# timer going
return 1
elif self.main_win_obj.results_list_temp_list:
# Not all downloaded files confirmed to exist yet, so return 1
# to keep the timer going a little longer
return 1
# The download operation has finished. The call to
# self.download_manager_finished() destroys the timer
self.download_manager_finished()
def update_timer_callback(self):
"""Called by GObject timer created by self.update_manager_start().
During an update operation, a GObject timer runs, so that the Output
tab can be updated at regular intervals.
For the benefit of systems with Gtk < 3.24, the timer continues running
for a few seconds at the end of the update operation.
Returns:
1 to keep the timer going
"""
if self.update_timer_check_time is None:
# Update operation still in progress, return 1 to keep the timer
# going
return 1
elif self.update_timer_check_time > time.time():
# Cooldown time not yet finished, return 1 to keep the timer going
return 1
else:
# The update operation has finished. The call to
# self.update_manager_finished() destroys the timer
self.update_manager_finished()
def refresh_timer_callback(self):
"""Called by GObject timer created by self.refresh_manager_continue().
During a refresh operation, a GObject timer runs, so that the Output
tab can be updated at regular intervals.
For the benefit of systems with Gtk < 3.24, the timer continues running
for a few seconds at the end of the refresh operation.
Returns:
1 to keep the timer going
"""
if self.refresh_timer_check_time is None:
# Refresh operation still in progress, return 1 to keep the timer
# going
return 1
elif self.refresh_timer_check_time > time.time():
# Cooldown time not yet finished, return 1 to keep the timer going
return 1
else:
# The refresh operation has finished. The call to
# self.refresh_manager_finished() destroys the timer
self.refresh_manager_finished()
def info_timer_callback(self):
"""Called by GObject timer created by self.info_manager_start().
During an info operation, a GObject timer runs, so that the Output tab
can be updated at regular intervals.
For the benefit of systems with Gtk < 3.24, the timer continues running
for a few seconds at the end of the info operation.
Returns:
1 to keep the timer going
"""
if self.info_timer_check_time is None:
# Info operation still in progress, return 1 to keep the timer
# going
return 1
elif self.info_timer_check_time > time.time():
# Cooldown time not yet finished, return 1 to keep the timer going
return 1
else:
# The info operation has finished. The call to
# self.info_manager_finished() destroys the timer
self.info_manager_finished()
def tidy_timer_callback(self):
"""Called by GObject timer created by self.tidy_manager_start().
During a tidy operation, a GObject timer runs, so that the Output tab
can be updated at regular intervals.
For the benefit of systems with Gtk < 3.24, the timer continues running
for a few seconds at the end of the tidy operation.
Returns:
1 to keep the timer going
"""
if self.tidy_timer_check_time is None:
# Tidy operation still in progress, return 1 to keep the timer
# going
return 1
elif self.tidy_timer_check_time > time.time():
# Cooldown time not yet finished, return 1 to keep the timer going
return 1
else:
# The tidy operation has finished. The call to
# self.tidy_manager_finished() destroys the timer
self.tidy_manager_finished()
def process_timer_callback(self):
"""Called by GObject timer created by self.process_manager_continue().
During a process operation, a GObject timer runs, so that the Output
tab can be updated at regular intervals.
For the benefit of systems with Gtk < 3.24, the timer continues running
for a few seconds at the end of the process operation.
Returns:
1 to keep the timer going
"""
if self.process_timer_check_time is None:
# Process operation still in progress, return 1 to keep the timer
# going
return 1
elif self.process_timer_check_time > time.time():
# Cooldown time not yet finished, return 1 to keep the timer going
return 1
else:
# The process operation has finished. The call to
# self.process_manager_finished() destroys the timer
self.process_manager_finished()
# (Menu item and toolbar button callbacks)
def on_button_apply_error_filter(self, action, par):
"""Called from a callback in self.do_startup().
Applies a filter to the Errors List, hiding any messages which don't
match the search text specified by the user.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Apply the filter
self.main_win_obj.errors_list_apply_filter()
def on_button_apply_filter(self, action, par):
"""Called from a callback in self.do_startup().
Applies a filter to the Video Catalogue, hiding any videos which don't
match the search text specified by the user.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Sanity check
if not self.main_win_obj.video_catalogue_dict:
return self.system_error(
187,
'Apply filter request failed sanity check',
)
# Apply the filter
self.main_win_obj.video_catalogue_apply_filter()
def on_button_cancel_date(self, action, par):
"""Called from a callback in self.do_startup().
Changes the Video Catalogue page to the first one, after showing a page
matching a particular date.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_catalogue_unshow_date()
def on_button_cancel_error_filter(self, action, par):
"""Called from a callback in self.do_startup().
Cancels the filter, restoring filtered messages in the Errors List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Apply the filter
self.main_win_obj.errors_list_cancel_filter()
def on_button_cancel_filter(self, action, par):
"""Called from a callback in self.do_startup().
Cancels the filter, restoring all hidden videos in the Video Catalogue.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Sanity check
if not self.main_win_obj.video_catalogue_dict:
return self.system_error(
188,
'Cancel filter request failed sanity check',
)
# Cancel the filter
self.main_win_obj.video_catalogue_cancel_filter()
def on_button_check_all(self, action, par):
"""Called from a callback in self.do_startup().
Call a function to start a new download operation (if allowed).
Unlike the corresponding self.on_menu_check_all button, this function
will check only the marked items, if any.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
media_list = []
for name in self.main_win_obj.video_index_marker_dict.keys():
if name in self.media_name_dict:
dbid = self.media_name_dict[name]
if dbid in self.media_reg_dict:
media_list.append(self.media_reg_dict[dbid])
self.download_manager_start(
'sim',
False, # Not called from self.script_slow_timer_callback()
media_list, # May be empty, in which case everything is checked
)
def on_button_classic_add_urls(self, action, par):
"""Called from a callback in self.do_startup().
In the Classic Mode tab, transfers URLs in the textview into the
Classic Progress List, creating a new dummy media.Video object for each
URL, and updating IVs.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.classic_mode_tab_add_urls()
def on_button_classic_archive(self, action, par):
"""Called from a callback in self.do_startup().
Enables/disables the youtube-dl archive file in downloads from the
Classic Mode tab.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if self.main_win_obj.classic_archive_button.get_active():
self.classic_ytdl_archive_flag = True
else:
self.classic_ytdl_archive_flag = False
def on_button_classic_dest_dir(self, action, par):
"""Called from a callback in self.do_startup().
Opens the file chooser dialogue, so the user can set a new destination
directory for videos downloaded in the Classic Mode tab.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
dialogue_win = self.dialogue_manager_obj.show_file_chooser(
_('Please select a destination folder'),
self.main_win_obj,
'folder',
)
response = dialogue_win.run()
dest_dir = dialogue_win.get_filename()
dialogue_win.destroy()
if response == Gtk.ResponseType.OK:
# Update IVs. Don't add a duplicate directory, but do move a
# duplicate to the top (and apply the maximum size, if required)
mod_list = [dest_dir]
for item in self.classic_dir_list:
if item != dest_dir:
mod_list.append(item)
if len(mod_list) >= self.classic_dir_max:
break
self.classic_dir_list = mod_list.copy()
# Update the combo in the main window
self.main_win_obj.classic_mode_tab_add_dest_dir()
def on_button_classic_dest_dir_open(self, action, par):
"""Called from a callback in self.do_startup().
Opens the directory for videos downloaded in the Classic Mode tab.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
utils.open_file(self, self.classic_dir_list[0])
def on_button_classic_clear(self, action, par):
"""Called from a callback in self.do_startup().
Empties the Classic Progress List. Modified version of
self.on_button_classic_remove(), which removes only the selected
videos.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
dbid_list = list(self.main_win_obj.classic_media_dict.keys())
if not dbid_list:
return
# Prompt for confirmation
msg = _('Are you sure you want to clear this list?')
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'main_win_classic_mode_tab_remove_rows',
# Specified options
'data': dbid_list,
},
)
def on_button_classic_clear_dl(self, action, par):
"""Called from a callback in self.do_startup().
Removes all downloaded lines from the Classic Progress List, leaving
any downloads that have not yet started (or which failed). Modified
version of self.on_button_classic_remove(), which removes only the
selected videos.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
video_list = list(self.main_win_obj.classic_media_dict.values())
# Filter out un-downloaded videos
dbid_list = []
for dummy_obj in video_list:
if dummy_obj.dummy_path is not None:
dbid_list.append(dummy_obj.dbid)
if not dbid_list:
return
# Prompt for confirmation
msg = _('Are you sure you want to clear downloaded videos?')
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'main_win_classic_mode_tab_remove_rows',
# Specified options
'data': dbid_list,
},
)
def on_button_classic_download(self, action, par):
"""Called from a callback in self.do_startup().
Starts a download operation for the URLs added to the Classic Progress
List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.classic_mode_tab_start_download()
def on_button_classic_ffmpeg(self, action, par):
"""Called from a callback in self.do_startup().
Processes the selected videos using FFmpeg.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
selection = self.main_win_obj.classic_progress_treeview.get_selection()
(model, path_list) = selection.get_selected_rows()
if not path_list:
# Nothing selected
return
# Get the the dummy media.Video objects for each selected row. Filter
# out any whose filename is not known (so cannot be processed)
video_list = []
for path in path_list:
this_iter = model.get_iter(path)
dbid = model[this_iter][0]
video_obj = self.main_win_obj.classic_media_dict[dbid]
if video_obj.dummy_path is not None:
video_list.append(video_obj)
if not video_list:
self.dialogue_manager_obj.show_msg_dialogue(
_('Only checked/downloaded videos can be processed by FFmpeg'),
'error',
'ok',
)
else:
# Create an edit window for the current FFmpegOptionsManager
# object. Supply it with the list of videos, so that the user can
# start the process operation from the edit window
config.FFmpegOptionsEditWin(
self,
self.ffmpeg_options_obj,
video_list,
)
def on_button_classic_menu(self, action, par):
"""Called from a callback in self.do_startup().
Opens a popup menu for the Classic Mode tab.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Open the popup menu
self.main_win_obj.classic_popup_menu()
def on_button_classic_move_up(self, action, par):
"""Called from a callback in self.do_startup().
In the Classic Progress List, moves the selected item(s) up.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.classic_mode_tab_move_row(True)
def on_button_classic_move_down(self, action, par):
"""Called from a callback in self.do_startup().
In the Classic Progress List, moves the selected item(s) down.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.classic_mode_tab_move_row(False)
def on_button_classic_open(self, action, par):
"""Called from a callback in self.do_startup().
Opens the destination(s) of any videos downloaded from the selected
rows in the Classic Progress List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
selection = self.main_win_obj.classic_progress_treeview.get_selection()
(model, path_list) = selection.get_selected_rows()
if not path_list:
# Nothing selected
return
# Get the the dummy media.Video objects for each selected row, and
# produce a list of destinations, ignoring duplicates
dir_list = []
for path in path_list:
this_iter = model.get_iter(path)
dbid = model[this_iter][0]
dummy_obj = self.main_win_obj.classic_media_dict[dbid]
if dummy_obj.dummy_dir \
and not dummy_obj.dummy_dir in dir_list:
dir_list.append(dummy_obj.dummy_dir)
if not dir_list:
self.dialogue_manager_obj.show_msg_dialogue(
_('No destination(s) to show'),
'error',
'ok',
)
else:
for this_dir in dir_list:
utils.open_file(self, this_dir)
def on_button_classic_play(self, action, par):
"""Called from a callback in self.do_startup().
Plays any videos downloaded from the selected rows in the Classic
Progress List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
selection = self.main_win_obj.classic_progress_treeview.get_selection()
(model, path_list) = selection.get_selected_rows()
if not path_list:
# Nothing selected
return
# Get the the dummy media.Video objects for each selected row, and
# filter out those for which no video(s) have been downloaded
video_list = []
for path in path_list:
this_iter = model.get_iter(path)
dbid = model[this_iter][0]
video_obj = self.main_win_obj.classic_media_dict[dbid]
if video_obj.dummy_path is not None:
video_list.append(video_obj.dummy_path)
if not video_list:
self.dialogue_manager_obj.show_msg_dialogue(
_('No video(s) have been downloaded'),
'error',
'ok',
)
else:
for video_path in video_list:
utils.open_file(self, video_path)
def on_button_classic_redownload(self, action, par):
"""Called from a callback in self.do_startup().
Redownloads the selected rows in the Classic Progress List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
selection = self.main_win_obj.classic_progress_treeview.get_selection()
(model, path_list) = selection.get_selected_rows()
if not path_list:
# Nothing selected
return
if not self.download_manager_obj:
# No download operation is currently in progress, so prepare a new
# one
# Get the dummy media.Video objects for each selected row
video_list = []
for path in path_list:
this_iter = model.get_iter(path)
dbid = model[this_iter][0]
video_obj = self.main_win_obj.classic_media_dict[dbid]
video_list.append(video_obj)
# Mark the video as not downloaded
video_obj.set_dl_flag(False)
# Delete the files associated with the video
self.delete_video_files(video_obj)
# Start the download operation
if not self.classic_custom_dl_flag:
self.download_manager_start('classic_real', False, video_list)
else:
self.download_manager_start(
'classic_custom',
False,
video_list,
)
else:
# A download operation is already in progress. If any of the
# selected videos are being downloaded, halt that download. Then,
# mark the videos to be downloaded again
# Get the .dbid of the dummy media.Video objects for each selected
# row
dbid_dict = {}
for path in path_list:
this_iter = model.get_iter(path)
dbid_dict[model[this_iter][0]] = None
# Stop any downloads matching one of these dbids
for worker_obj in self.download_manager_obj.worker_list:
if worker_obj.running_flag \
and worker_obj.download_item_obj \
and worker_obj.download_item_obj.media_data_obj.dbid \
in dbid_dict:
worker_obj.downloader_obj.stop()
# Re-add the videos to the download list. The existing row in the
# Classic Progress List is automatically re-used
list_obj = self.download_manager_obj.download_list_obj
for dbid in dbid_dict.keys():
dummy_obj = self.main_win_obj.classic_media_dict[dbid]
download_item_obj = list_obj.create_dummy_item(dummy_obj)
if download_item_obj:
# Update the main window's progress bar
self.download_manager_obj.nudge_progress_bar()
def on_button_classic_remove(self, action, par):
"""Called from a callback in self.do_startup().
Removes the selected rows from the Classic Progress List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
selection = self.main_win_obj.classic_progress_treeview.get_selection()
(model, path_list) = selection.get_selected_rows()
if not path_list:
# Nothing selected
return
# Get the .dbid of the dummy media.Video objects for each selected
# row
dbid_list = []
for path in path_list:
this_iter = model.get_iter(path)
dbid_list.append(model[this_iter][0])
# Prompt for confirmation
msg = _('Are you sure you want to remove the selected item(s)?')
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'main_win_classic_mode_tab_remove_rows',
# Specified options
'data': dbid_list,
},
)
def on_button_classic_stop(self, action, par):
"""Called from a callback in self.do_startup().
If a download operation is in progress, halts downloads for any of
the selected rows in the Classic Progress List.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
selection = self.main_win_obj.classic_progress_treeview.get_selection()
(model, path_list) = selection.get_selected_rows()
if not path_list:
# Nothing selected
return
# Get the .dbid of the dummy media.Video objects for each selected
# row
dbid_dict = {}
for path in path_list:
this_iter = model.get_iter(path)
dbid_dict[model[this_iter][0]] = None
# Now, if a download operation is in progress, stop any downloads
# matching one of these dbids
if self.download_manager_obj:
for worker_obj in self.download_manager_obj.worker_list:
if worker_obj.running_flag \
and worker_obj.download_item_obj \
and worker_obj.download_item_obj.media_data_obj.dbid \
in dbid_dict:
worker_obj.downloader_obj.stop()
def on_button_custom_dl_all(self, action, par):
"""Called from a callback in self.do_startup().
Call a function to start a new (custom) download operation (if
allowed).
Unlike the corresponding self.on_menu_custom_dl_all button, this
function will custom download only the marked items, if any.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
media_list = []
for name in self.main_win_obj.video_index_marker_dict.keys():
if name in self.media_name_dict:
dbid = self.media_name_dict[name]
if dbid in self.media_reg_dict:
media_list.append(self.media_reg_dict[dbid])
if not self.general_custom_dl_obj.dl_by_video_flag \
or not self.general_custom_dl_obj.dl_precede_flag:
self.download_manager_start(
'custom_real',
False, # Not called by the timer
media_list, # Download all media data objects
self.general_custom_dl_obj,
)
else:
self.download_manager_start(
'custom_sim',
False, # Not called by the timer
media_list, # Download all media data objects
self.general_custom_dl_obj,
)
def on_button_download_all(self, action, par):
"""Called from a callback in self.do_startup().
Call a function to start a new download operation (if allowed).
Unlike the corresponding self.on_menu_download_all button, this
function will download only the marked items, if any.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
media_list = []
for name in self.main_win_obj.video_index_marker_dict.keys():
if name in self.media_name_dict:
dbid = self.media_name_dict[name]
if dbid in self.media_reg_dict:
media_list.append(self.media_reg_dict[dbid])
self.download_manager_start(
'real',
False, # Not called from self.script_slow_timer_callback()
media_list, # May be empty, in which case everything is downloaded
)
def on_button_drag_drop_add(self, action, par):
"""Called from a callback in self.do_startup().
Adds a new dropzone in the Drag and Drop tab.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Open the popup menu
self.main_win_obj.drag_drop_add_dropzone()
def on_button_find_date(self, action, par):
"""Called from a callback in self.do_startup().
Changes the Video Catalogue page to the first one containing a video
whose upload time is the first one on or after date specified by the
user.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Sanity check
if not self.main_win_obj.video_catalogue_dict:
return self.system_error(
189,
'Find videos by date request failed sanity check',
)
# Prompt the user for a new calendar date
dialogue_win = mainwin.CalendarDialogue(self.main_win_obj)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window, before destroying it
if response == Gtk.ResponseType.OK:
date_tuple = dialogue_win.calendar.get_date()
dialogue_win.destroy()
if response == Gtk.ResponseType.OK and date_tuple:
year = date_tuple[0] # e.g. 2011
month = date_tuple[1] + 1 # Values in range 0-11
day = date_tuple[2] # Values in range 1-31
# Convert the specified date into the epoch time at the start of
# that day
epoch_time = datetime.datetime(year, month, day, 0, 0).timestamp()
# Get the channel, playlist or folder currently visible in the
# Video Catalogue
dbid = self.media_name_dict[self.main_win_obj.video_index_current]
container_obj = self.media_reg_dict[dbid]
count = 0
if self.catalogue_sort_mode == 'receive':
# Sort by download time
for child_obj in container_obj.child_list:
if isinstance(child_obj, media.Video) \
and child_obj.receive_time is not None \
and child_obj.receive_time < epoch_time:
break
else:
count += 1
else:
# Sort by upload time
for child_obj in container_obj.child_list:
if isinstance(child_obj, media.Video) \
and child_obj.upload_time is not None \
and child_obj.upload_time < epoch_time:
break
else:
count += 1
# (If the date is newer than all videos, then use the first video)
if count == 0:
count = 1
# Find the corresponding page in the Video Catalogue, and make it
# visible
self.main_win_obj.video_catalogue_show_date(
math.ceil(count / self.catalogue_page_size),
)
def on_button_first_page(self, action, par):
"""Called from a callback in self.do_startup().
Changes the Video Catalogue page to the first one.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
1,
True, # Reset scrollbars
True, # Don't cancel the filter, if applied
)
def on_button_hide_system(self, action, par):
"""Called from a callback in self.do_startup().
Show or hide (most) system folders, depending on whether the
togglebutton is selected, or not.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Toggle the menu item, which sets the IV (and updates the toolbar
# button)
if not self.main_win_obj.hide_system_menu_item.get_active():
self.main_win_obj.hide_system_menu_item.set_active(True)
else:
self.main_win_obj.hide_system_menu_item.set_active(False)
def on_button_last_page(self, action, par):
"""Called from a callback in self.do_startup().
Changes the Video Catalogue page to the last one.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_last_page,
True, # Reset scrollbars
True, # Don't cancel the filter, if applied
)
def on_button_next_page(self, action, par):
"""Called from a callback in self.do_startup().
Changes the Video Catalogue page to the next one.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_current_page + 1,
True, # Reset scrollbars
True, # Don't cancel the filter, if applied
)
def on_button_previous_page(self, action, par):
"""Called from a callback in self.do_startup().
Changes the Video Catalogue page to the previous one.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_current_page - 1,
True, # Reset scrollbars
True, # Don't cancel the filter, if applied
)
def on_button_resort_catalogue(self, action, par):
"""Called from a callback in self.do_startup().
Forces a resort of the channel/playlist/folder visible in the Video
Catalogue.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_force_resort()
def on_button_scroll_down(self, action, par):
"""Called from a callback in self.do_startup().
Scrolls the Video Catalogue page to the bottom.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
adjust = self.main_win_obj.catalogue_scrolled.get_vadjustment()
adjust.set_value(adjust.get_upper())
def on_button_scroll_up(self, action, par):
"""Called from a callback in self.do_startup().
Scrolls the Video Catalogue page to the top.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.catalogue_scrolled.get_vadjustment().set_value(0)
def on_button_show_filter(self, action, par):
"""Called from a callback in self.do_startup().
Reveals or hides another toolbar just below the Video Catalogue. The
additional toolbar contains filter options.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if not self.catalogue_show_filter_flag:
self.catalogue_show_filter_flag = True
else:
self.catalogue_show_filter_flag = False
# Update the button in the Video Catalogue's toolbar
self.main_win_obj.update_catalogue_filter_widgets()
def on_button_stop_operation(self, action, par):
"""Called from a callback in self.do_startup().
Stops the current download/update/refresh/info/tidy operation (but not
livestream operations, which run in the background and are halted
immediately, if a different type of operation wants to start).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.operation_halted_flag = True
# (The livestream operation runs silently in the background, so the
# toolbar button is desensitised and can't be used to stop it)
if self.download_manager_obj:
self.download_manager_obj.stop_download_operation()
elif self.update_manager_obj:
self.update_manager_obj.stop_update_operation()
elif self.refresh_manager_obj:
self.refresh_manager_obj.stop_refresh_operation()
elif self.info_manager_obj:
self.info_manager_obj.stop_info_operation()
elif self.tidy_manager_obj:
self.tidy_manager_obj.stop_tidy_operation()
elif self.process_manager_obj:
self.process_manager_obj.stop_process_operation()
def on_button_switch_view(self, action, par):
"""Called from a callback in self.do_startup().
Switches between Video Catalogue modes. Each mode specifies how videos
are displayed in the Video Catalogue, and what data is displayed for
each video.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# self.catalogue_mode_list provides an ordered list of values for
# self.catalogue_mode and self.catalogue_mode_type
# Find the current setting in the list, and switch to the next setting
catalogue_mode_list = self.catalogue_mode_list.copy()
while catalogue_mode_list:
mini_list = catalogue_mode_list.pop(0)
if mini_list[0] == self.catalogue_mode:
if catalogue_mode_list:
# Not at the end of the list yet
next_mini_list = catalogue_mode_list[0]
self.catalogue_mode = next_mini_list[0]
self.catalogue_mode_type = next_mini_list[1]
else:
# Go back to the beginning of the list
first_mini_list = self.catalogue_mode_list[0]
self.catalogue_mode = first_mini_list[0]
self.catalogue_mode_type = first_mini_list[1]
break
# In case we are switching between two settings for videos displayed on
# a grid, reset the minimum gridbox sizes for each thumbnail size
self.main_win_obj.video_catalogue_grid_reset_sizes()
# Redraw the Video Catalogue, but only if something was already drawn
# there (and keep the current page number)
if self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_current_page,
)
def on_button_use_regex(self, action, par):
"""Called from a callback in self.do_startup().
When the user clicks the Regex togglebutton in the toolbar just below
the Video Catalogue, updates IVs.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Sanity check
if not self.main_win_obj.video_catalogue_dict:
return self.system_error(
190,
'Use regex request failed sanity check',
)
if not self.main_win_obj.catalogue_regex_togglebutton.get_active():
self.catologue_use_regex_flag = False
else:
self.catologue_use_regex_flag = True
def on_menu_about(self, action, par):
"""Called from a callback in self.do_startup().
Show a standard 'about' dialogue window.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
dialogue_win = Gtk.AboutDialog()
dialogue_win.set_transient_for(self.main_win_obj)
dialogue_win.set_destroy_with_parent(True)
dialogue_win.set_program_name(__main__.__packagename__.title())
dialogue_win.set_version('v' + __main__.__version__)
dialogue_win.set_copyright(__main__.__copyright__)
dialogue_win.set_license(__main__.__license__)
dialogue_win.set_website(__main__.__website__)
dialogue_win.set_website_label(
__main__.__packagename__.title() + ' website'
)
dialogue_win.set_comments(__main__.__description__)
dialogue_win.set_logo(
self.main_win_obj.pixbuf_dict['system_icon'],
)
dialogue_win.set_authors(__main__.__author_list__)
dialogue_win.add_credit_section('Credits', __main__.__credit_list__)
dialogue_win.set_title('')
dialogue_win.connect('response', self.on_menu_about_close)
dialogue_win.show()
def on_menu_about_close(self, action, par):
"""Called from a callback in self.do_startup().
Close the 'about' dialogue window.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
action.destroy()
def on_menu_add_bulk(self, action, par):
"""Called from a callback in self.do_startup().
Creates a dialogue window to allow the user to specify new channels/
playlists. If any are specifed, creates new media.Channel and/or
media.Playlist objects.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# If a folder is selected in the Video Index, the dialogue window
# should suggest that as the new folder's parent folder
suggest_parent_name = None
if self.main_win_obj.video_index_current:
dbid = self.media_name_dict[self.main_win_obj.video_index_current]
container_obj = self.media_reg_dict[dbid]
if isinstance(container_obj, media.Folder) \
and not container_obj.fixed_flag \
and container_obj.restrict_mode != 'full':
suggest_parent_name = container_obj.name
# Open the dialogue window
dialogue_win = mainwin.AddBulkDialogue(
self.main_win_obj,
suggest_parent_name,
)
response = dialogue_win.run()
# Halt its clipboard timer, if running
if dialogue_win.clipboard_timer_id:
GObject.source_remove(dialogue_win.clipboard_timer_id)
# Retrieve user choices from the dialogue window
if response == Gtk.ResponseType.OK:
# Find the name of the parent media data object (a media.Folder),
# if one was specified...
parent_name = None
if hasattr(dialogue_win, 'parent_name'):
parent_name = dialogue_win.parent_name
elif suggest_parent_name is not None:
parent_name = suggest_parent_name
# Find the parent media data object (a media.Folder), if specified
parent_obj = None
if parent_name and parent_name in self.media_name_dict:
dbid = self.media_name_dict[parent_name]
parent_obj = self.media_reg_dict[dbid]
# Create each new channel/playlist
for row in dialogue_win.liststore:
container_type = row[0]
container_name = row[2]
container_url = row[3]
if container_type == 'channel':
container_obj = self.add_channel(
container_name,
parent_obj,
container_url,
)
else:
container_obj = self.add_playlist(
container_name,
parent_obj,
container_url,
)
# Add the channel/playlist to Video Index
if container_obj:
if suggest_parent_name is not None \
and suggest_parent_name \
== self.main_win_obj.video_index_current:
# The container has been added to the currently
# selected folder; the True argument tells the
# function not to select the container
self.main_win_obj.video_index_add_row(
container_obj,
True,
)
else:
# Do select the new container
self.main_win_obj.video_index_add_row(container_obj)
# ...before destroying the dialogue window
dialogue_win.destroy()
def on_menu_add_channel(self, action, par):
"""Called from a callback in self.do_startup().
Creates a dialogue window to allow the user to specify a new channel.
If the user specifies a channel, creates a media.Channel object.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
keep_open_flag = True
dl_sim_flag = False
monitor_flag = False
# If a folder (but not a channel/playlist) is selected in the Video
# Index, use that as the dialogue window's suggested parent folder
suggest_parent_name = None
if self.main_win_obj.video_index_current:
dbid = self.media_name_dict[self.main_win_obj.video_index_current]
container_obj = self.media_reg_dict[dbid]
if isinstance(container_obj, media.Folder) \
and not container_obj.fixed_flag \
and container_obj.restrict_mode == 'open':
suggest_parent_name = container_obj.name
while keep_open_flag:
dialogue_win = mainwin.AddChannelDialogue(
self.main_win_obj,
suggest_parent_name,
dl_sim_flag,
monitor_flag,
)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
name = dialogue_win.entry.get_text()
source = dialogue_win.entry2.get_text()
dl_sim_flag = dialogue_win.radiobutton2.get_active()
monitor_flag = dialogue_win.checkbutton.get_active()
# ...and find the name of the parent media data object (a
# media.Folder), if one was specified...
parent_name = dialogue_win.parent_name
# ...and halt the timer, if running
if dialogue_win.clipboard_timer_id:
GObject.source_remove(dialogue_win.clipboard_timer_id)
# ...before destroying the dialogue window
dialogue_win.destroy()
if response != Gtk.ResponseType.OK:
keep_open_flag = False
else:
if name is None or re.search('^\s*$', name):
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('You must give the channel a name'),
'error',
'ok',
)
elif not self.check_container_name_is_legal(name):
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('The name \'{0}\' is not allowed').format(name),
'error',
'ok',
)
elif not source or not utils.check_url(source):
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('You must enter a valid URL'),
'error',
'ok',
)
elif name in self.media_name_dict:
# Another channel, playlist or folder is already using this
# name
keep_open_flag = False
self.reject_container_name(name)
else:
keep_open_flag = self.dialogue_keep_open_flag
# Remove leading/trailing whitespace from the name; make
# sure the name is not excessively long; reject system
# illegal names
name = utils.tidy_up_container_name(
self,
name,
self.container_name_max_len,
)
if name == '':
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('That name is not permitted on your system'),
'error',
'ok',
)
else:
# Find the parent media data object (a media.Folder),
# if specified
parent_obj = None
if parent_name and parent_name in self.media_name_dict:
dbid = self.media_name_dict[parent_name]
parent_obj = self.media_reg_dict[dbid]
if self.dialogue_keep_open_flag \
and self.dialogue_keep_container_flag:
suggest_parent_name = parent_name
# Create the new channel
channel_obj = self.add_channel(
name,
parent_obj,
source,
dl_sim_flag,
)
# Add the channel to Video Index
if channel_obj:
if suggest_parent_name is not None \
and suggest_parent_name \
== self.main_win_obj.video_index_current:
# The channel has been added to the currently
# selected folder; the True argument tells
# the function not to select the channel
self.main_win_obj.video_index_add_row(
channel_obj,
True,
)
else:
# Do select the new channel
self.main_win_obj.video_index_add_row(
channel_obj,
)
def on_menu_add_folder(self, action, par):
"""Called from a callback in self.do_startup().
Creates a dialogue window to allow the user to specify a new folder.
If the user specifies a folder, creates a media.Folder object.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# If a folder is selected in the Video Index, the dialogue window
# should suggest that as the new folder's parent folder
suggest_parent_name = None
if self.main_win_obj.video_index_current:
dbid = self.media_name_dict[self.main_win_obj.video_index_current]
container_obj = self.media_reg_dict[dbid]
if isinstance(container_obj, media.Folder) \
and not container_obj.fixed_flag \
and container_obj.restrict_mode != 'full':
suggest_parent_name = container_obj.name
dialogue_win = mainwin.AddFolderDialogue(
self.main_win_obj,
suggest_parent_name,
)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
name = dialogue_win.entry.get_text()
dl_sim_flag = dialogue_win.radiobutton2.get_active()
# ...and find the name of the parent media data object (a
# media.Folder), if one was specified...
parent_name = dialogue_win.parent_name
# ...before destroying the dialogue window
dialogue_win.destroy()
if response == Gtk.ResponseType.OK:
if name is None or re.search('^\s*$', name):
self.dialogue_manager_obj.show_msg_dialogue(
_('You must give the folder a name'),
'error',
'ok',
)
elif not self.check_container_name_is_legal(name):
self.dialogue_manager_obj.show_msg_dialogue(
_('The name \'{0}\' is not allowed').format(name),
'error',
'ok',
)
elif name in self.media_name_dict:
# Another channel, playlist or folder is already using this
# name
self.reject_container_name(name)
else:
# Remove leading/trailing whitespace from the name; make sure
# the name is not excessively long
name = utils.tidy_up_container_name(
self,
name,
self.container_name_max_len,
)
if name == '':
self.dialogue_manager_obj.show_msg_dialogue(
_('That name is not permitted on your system'),
'error',
'ok',
)
else:
# Find the parent media data object (a media.Folder), if
# specified
parent_obj = None
if parent_name and parent_name in self.media_name_dict:
dbid = self.media_name_dict[parent_name]
parent_obj = self.media_reg_dict[dbid]
# Create the new folder
folder_obj = self.add_folder(name, parent_obj, dl_sim_flag)
# Add the folder to the Video Index
if folder_obj:
if self.main_win_obj.video_index_current:
# The new folder has been added inside the
# currently selected folder; the True argument
# tells the function not to select the new folder
self.main_win_obj.video_index_add_row(
folder_obj,
True,
)
else:
# Do select the new folder
self.main_win_obj.video_index_add_row(folder_obj)
def on_menu_add_playlist(self, action, par):
"""Called from a callback in self.do_startup().
Creates a dialogue window to allow the user to specify a new playlist.
If the user specifies a playlist, creates a media.PLaylist object.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
keep_open_flag = True
dl_sim_flag = False
monitor_flag = False
# If a folder (but not a channel/playlist) is selected in the Video
# Index, use that as the dialogue window's suggested parent folder
suggest_parent_name = None
if self.main_win_obj.video_index_current:
dbid = self.media_name_dict[self.main_win_obj.video_index_current]
container_obj = self.media_reg_dict[dbid]
if isinstance(container_obj, media.Folder) \
and not container_obj.fixed_flag \
and container_obj.restrict_mode == 'open':
suggest_parent_name = container_obj.name
while keep_open_flag:
dialogue_win = mainwin.AddPlaylistDialogue(
self.main_win_obj,
suggest_parent_name,
dl_sim_flag,
monitor_flag,
)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
name = dialogue_win.entry.get_text()
source = dialogue_win.entry2.get_text()
dl_sim_flag = dialogue_win.radiobutton2.get_active()
monitor_flag = dialogue_win.checkbutton.get_active()
# ...and find the name of the parent media data object (a
# media.Folder), if one was specified...
parent_name = dialogue_win.parent_name
# ...and halt the timer, if running
if dialogue_win.clipboard_timer_id:
GObject.source_remove(dialogue_win.clipboard_timer_id)
# ...before destroying the dialogue window
dialogue_win.destroy()
if response != Gtk.ResponseType.OK:
keep_open_flag = False
else:
if name is None or re.search('^\s*$', name):
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('You must give the playlist a name'),
'error',
'ok',
)
elif not self.check_container_name_is_legal(name):
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('The name \'{0}\' is not allowed').format(name),
'error',
'ok',
)
elif not source or not utils.check_url(source):
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('You must enter a valid URL'),
'error',
'ok',
)
elif name in self.media_name_dict:
# Another channel, playlist or folder is already using this
# name
keep_open_flag = False
self.reject_container_name(name)
else:
keep_open_flag = self.dialogue_keep_open_flag
# Remove leading/trailing whitespace from the name; make
# sure the name is not excessively long
name = utils.tidy_up_container_name(
self,
name,
self.container_name_max_len,
)
if name == '':
keep_open_flag = False
self.dialogue_manager_obj.show_msg_dialogue(
_('That name is not permitted on your system'),
'error',
'ok',
)
else:
# Find the parent media data object (a media.Folder),
# if specified
parent_obj = None
if parent_name and parent_name in self.media_name_dict:
dbid = self.media_name_dict[parent_name]
parent_obj = self.media_reg_dict[dbid]
if self.dialogue_keep_open_flag \
and self.dialogue_keep_container_flag:
suggest_parent_name = parent_name
# Create the playlist
playlist_obj = self.add_playlist(
name,
parent_obj,
source,
dl_sim_flag,
)
# Add the playlist to the Video Index
if playlist_obj:
if suggest_parent_name is not None \
and suggest_parent_name \
== self.main_win_obj.video_index_current:
# The playlist has been added to the currently
# selected folder; the True argument tells
# the function not to select the playlist
self.main_win_obj.video_index_add_row(
playlist_obj,
True,
)
else:
# Do select the new playlist
self.main_win_obj.video_index_add_row(
playlist_obj,
)
def on_menu_add_video(self, action, par):
"""Called from a callback in self.do_startup().
Creates a dialogue window to allow the user to specify one or more
videos. If the user supplies some URLs, creates media.Video objects.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
dialogue_win = mainwin.AddVideoDialogue(self.main_win_obj)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
text = dialogue_win.textbuffer.get_text(
dialogue_win.textbuffer.get_start_iter(),
dialogue_win.textbuffer.get_end_iter(),
False,
)
dl_sim_flag = dialogue_win.radiobutton2.get_active()
# ...and find the parent media data object (a media.Channel,
# media.Playlist or media.Folder)...
parent_name = dialogue_win.parent_name
dbid = self.media_name_dict[parent_name]
parent_obj = self.media_reg_dict[dbid]
# ...and halt the timer, if running
if dialogue_win.clipboard_timer_id:
GObject.source_remove(dialogue_win.clipboard_timer_id)
# ...before destroying the dialogue window
dialogue_win.destroy()
if response == Gtk.ResponseType.OK:
# Split text into a list of lines and filter out invalid URLs
video_list = []
duplicate_list = []
for line in text.split('\n'):
# Remove leading/trailing whitespace
line = utils.strip_whitespace(line)
# Perform checks on the URL. If it passes, remove leading/
# trailing whitespace
if utils.check_url(line):
video_list.append(utils.strip_whitespace(line))
# Check everything in the list against other media.Video objects
# with the same parent folder
for line in video_list:
if parent_obj.check_duplicate_video(line):
duplicate_list.append(line)
else:
self.add_video(parent_obj, line, dl_sim_flag)
# In the Video Index, select the parent media data object, which
# updates both the Video Index and the Video Catalogue
self.main_win_obj.video_index_select_row(parent_obj)
# If any duplicates were found, inform the user
if duplicate_list:
dialogue_win = mainwin.DuplicateVideoDialogue(
self.main_win_obj,
duplicate_list,
)
dialogue_win.run()
dialogue_win.destroy()
def on_menu_auto_switch(self, action, par):
"""Called from a callback in self.do_startup().
Sets the flag which switches to a profile on startup.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if not self.auto_switch_profile_flag:
self.auto_switch_profile_flag = True
else:
self.auto_switch_profile_flag = True
def on_menu_create_profile(self, action, par):
"""Called from a callback in self.do_startup().
Creates a profile to remember items marked in the Video Index.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Don't create profiles if nothing marked
if not self.main_win_obj.video_index_marker_dict:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_(
'No channels, playlists or folders are marked for' \
+ ' download',
),
'error',
'ok',
)
return
# A maxmimum number of profiles applies
elif len(self.profile_dict) >= self.profile_max:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_(
'The maximum number of profiles permitted is {0}',
).format(self.profile_max),
'error',
'ok',
)
return
# Prompt the user to choose a profile name
dialogue_win = mainwin.CreateProfileDialogue(self.main_win_obj)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
profile_name = dialogue_win.profile_name
# ...before destroying the dialogue window
dialogue_win.destroy()
if response != Gtk.ResponseType.OK or profile_name is None:
return
# Check for duplicate names
if profile_name in self.profile_dict:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_(
'A profile called \'{0}\' already exists',
).format(profile_name),
'error',
'ok',
)
return
# Get a list of marked items in the Video Index
dbid_list = []
for this_name in self.main_win_obj.video_index_marker_dict.keys():
dbid_list.append(self.media_name_dict[this_name])
# Create the profile
self.add_profile(profile_name, dbid_list)
# Show confirmation dialogue
self.dialogue_manager_obj.show_msg_dialogue(
_('Created the profile \'{0}\'').format(profile_name),
'info',
'ok',
)
def on_menu_cancel_live(self, action, par):
"""Called from a callback in self.do_startup().
Cancels all livestream actions (auto-notify, auto-open, download at
start, download at stop).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# The actions are stored in five different dictionaries. Compile a
# single dictionary, eliminating duplicates, so we can count how
# many media.Video objects are affected (and updte the Video
# Catalogue)
video_dict = {}
for video_obj in self.media_reg_auto_notify_dict.values():
video_dict[video_obj.dbid] = video_obj
for video_obj in self.media_reg_auto_alarm_dict.values():
video_dict[video_obj.dbid] = video_obj
for video_obj in self.media_reg_auto_open_dict.values():
video_dict[video_obj.dbid] = video_obj
for video_obj in self.media_reg_auto_dl_start_dict.values():
video_dict[video_obj.dbid] = video_obj
for video_obj in self.media_reg_auto_dl_stop_dict.values():
video_dict[video_obj.dbid] = video_obj
# Cancel livestream actions by emptying the IVs
self.media_reg_auto_notify_dict = {}
self.media_reg_auto_alarm_dict = {}
self.media_reg_auto_open_dict = {}
self.media_reg_auto_dl_start_dict = {}
self.media_reg_auto_dl_stop_dict = {}
# Update the Video Catalogue
for video_obj in video_dict.values():
GObject.timeout_add(
0,
self.main_win_obj.video_catalogue_update_video,
video_obj,
)
# Show confirmation
count = len(video_dict)
if not count:
msg = _('There were no livestream alerts to cancel')
elif count == 1:
msg = _('Livestream alerts for 1 video were cancelled')
else:
msg = _(
'Livestream alerts for {0} videos were cancelled',
).format(str(count))
self.dialogue_manager_obj.show_msg_dialogue(
msg,
'info',
'ok',
None, # Parent window is main window
)
def on_menu_change_db(self, action, par):
"""Called from a callback in self.do_startup().
Opens the preference window at the right tab, so that the user can
switch databases.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
config.SystemPrefWin(self, 'db')
def on_menu_check_db(self, action, par):
"""Called from a callback in self.do_startup().
Runs a database integrity check, without the need to open the
preference window first.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.check_integrity_db()
def on_menu_check_all(self, action, par):
"""Called from a callback in self.do_startup().
Call a function to start a new download operation (if allowed).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.download_manager_start('sim')
def on_menu_check_version(self, action, par):
"""Called from a callback in self.do_startup().
Check for Tartube updates.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.info_manager_start('version')
def on_menu_close_tray(self, action, par):
"""Called from a callback in self.do_startup().
Closes the main window to the system tray.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.toggle_visibility()
def on_menu_create_profile(self, action, par):
"""Called from a callback in self.do_startup().
Creates a profile to remember items marked in the Video Index.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Don't create profiles if nothing marked
if not self.main_win_obj.video_index_marker_dict:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_(
'No channels, playlists or folders are marked for' \
+ ' download',
),
'error',
'ok',
)
return
# A maxmimum number of profiles applies
elif len(self.profile_dict) >= self.profile_max:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_(
'The maximum number of profiles permitted is {0}',
).format(self.profile_max),
'error',
'ok',
)
return
# Prompt the user to choose a profile name
dialogue_win = mainwin.CreateProfileDialogue(self.main_win_obj)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
profile_name = dialogue_win.profile_name
# ...before destroying the dialogue window
dialogue_win.destroy()
if response != Gtk.ResponseType.OK or profile_name is None:
return
# Check for duplicate names
if profile_name in self.profile_dict:
dialogue_win = self.dialogue_manager_obj.show_msg_dialogue(
_(
'A profile called \'{0}\' already exists',
).format(profile_name),
'error',
'ok',
)
return
# Get a list of marked items in the Video Index
dbid_list = []
for this_name in self.main_win_obj.video_index_marker_dict.keys():
dbid_list.append(self.media_name_dict[this_name])
# Create the profile
self.add_profile(profile_name, dbid_list)
# Show confirmation dialogue
self.dialogue_manager_obj.show_msg_dialogue(
_('Created the profile \'{0}\'').format(profile_name),
'info',
'ok',
)
def on_menu_custom_dl_all(self, action, par):
"""Called from a callback in self.do_startup().
Call a function to start a new (custom) download operation (if
allowed).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if not self.general_custom_dl_obj.dl_by_video_flag \
or not self.general_custom_dl_obj.dl_precede_flag:
self.download_manager_start(
'custom_real',
False, # Not called by the timer
[], # Download all media data objects
self.general_custom_dl_obj,
)
else:
self.download_manager_start(
'custom_sim',
False, # Not called by the timer
[], # Download all media data objects
self.general_custom_dl_obj,
)
def on_menu_custom_dl_select(self, action, par):
"""Called from a callback in self.do_startup().
Open a popup menu for the user to select a custom download manager,
before starting a custom download using that manager.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Open the popup menu
self.main_win_obj.custom_dl_popup_menu()
def on_menu_download_all(self, action, par):
"""Called from a callback in self.do_startup().
Call a function to start a new download operation (if allowed).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.download_manager_start('real')
def on_menu_export_db(self, action, par):
"""Called from a callback in self.do_startup().
Exports data from the Tartube database.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.export_from_db( [] )
def on_menu_general_options(self, action, par):
"""Called from a callback in self.do_startup().
Opens an edit window for the General Options Manager.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
config.OptionsEditWin(self, self.general_options_obj)
def on_menu_go_website(self, action, par):
"""Called from a callback in self.do_startup().
Opens the Tartube website.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
utils.open_file(self, __main__.__website__)
def on_menu_hide_system(self, action, par):
"""Called from a callback in self.do_startup().
Show or hide (most) system folders, depending on whether the menu item
is selected, or not.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Update the IV
if not self.main_win_obj.hide_system_menu_item.get_active():
self.toolbar_system_hide_flag = False
else:
self.toolbar_system_hide_flag = True
# Update the main window, showing/hiding system folders as necessary
self.main_win_obj.update_window_after_show_hide()
def on_menu_import_db(self, action, par):
"""Called from a callback in self.do_startup().
Imports data into the Tartube database.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.import_into_db()
def on_menu_import_yt(self, action, par):
"""Called from a callback in self.do_startup().
Creates a wizard window to import YouTube subscriptions.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
wizwin.ImportYTWizWin(self)
def on_menu_install_ffmpeg(self, action, par):
"""Called from a callback in self.do_startup().
Start an update operation to install FFmpeg (on MS Windows only).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.update_manager_start('ffmpeg')
def on_menu_install_matplotlib(self, action, par):
"""Called from a callback in self.do_startup().
Start an update operation to install matplotlib (on MS Windows only).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.update_manager_start('matplotlib')
def on_menu_install_streamlink(self, action, par):
"""Called from a callback in self.do_startup().
Start an update operation to install streamlink (on MS Windows only).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.update_manager_start('streamlink')
def on_menu_live_preferences(self, action, par):
"""Called from a callback in self.do_startup().
Opens a preference window to edit livestream preferences.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
config.SystemPrefWin(self, 'live')
def on_menu_mark_all(self, action, par):
"""Called from a callback in self.do_startup().
Marks all items in the Video Index.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_index_set_marker()
def on_menu_open_msys2(self, action, par):
"""Called from a callback in self.do_startup().
On MS Windows, opens the MINGW terminal for MSYS2.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if 'PROGRAMFILES(X86)' in os.environ:
utils.open_file(self, '..\\..\\..\\mingw64.exe')
else:
utils.open_file(self, '..\\..\\..\\mingw32.exe')
if self.show_msys2_dialogue_flag:
dialogue_win = mainwin.MSYS2Dialogue(self.main_win_obj)
dialogue_win.run()
dialogue_win.destroy()
def on_menu_refresh_db(self, action, par):
"""Called from a callback in self.do_startup().
Starts a refresh operation.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.refresh_manager_start()
def on_menu_reset_container(self, action, par):
"""Called from a callback in self.do_startup().
Creates a dialogue window to allow the user to reset channel/playlist
names in Tartube's database, replacing them with names gathered from
their child video's metadata (i.e. the original channel/playlist names
used on the site from which the videos were downloaded).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# If the user needs to check/download channels/playlists first, then
# tell them about it
if not self.media_reset_container_dict:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Before trying to reset channel/playlist names, you must' \
+ ' check or download at one least one video from each!',
),
'error',
'ok',
None, # Parent window is main window
)
return
# Open the dialogue window
dialogue_win = mainwin.ResetContainerDialogue(self.main_win_obj)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window, and reset any
# channel/playlist names as appropriate
if response != Gtk.ResponseType.OK:
dialogue_win.destroy()
else:
for dbid in dialogue_win.reset_dict.keys():
if dialogue_win.reset_dict[dbid] \
and dbid in self.media_reg_dict \
and dbid in self.media_reset_container_dict:
# (As well as using the name extracted from the child
# videos' metadata, the user can type a new name
# directly)
if dbid in dialogue_win.custom_dict:
new_name = dialogue_win.custom_dict[dbid]
else:
new_name = self.media_reset_container_dict[dbid]
if self.rename_container_silently(
self.media_reg_dict[dbid],
new_name,
):
# (Remove this channel/playlist from the IV, so if the
# user opens the dialogue window again, it's not
# present)
del self.media_reset_container_dict[dbid]
# ...before destroying the dialogue window
dialogue_win.destroy()
# Reset the Video Index (since any changed names will affect the
# order in which channels/playlists/folders are listed)
self.main_win_obj.video_index_catalogue_reset()
def on_menu_save_all(self, action, par):
"""Called from a callback in self.do_startup().
Save the config file, and then the Tartube database.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
if not self.disable_load_save_flag:
self.save_config()
if not self.disable_load_save_flag:
self.save_db()
# Show a dialogue window for confirmation (unless file load/save has
# been disabled, in which case a dialogue has already appeared)
if not self.disable_load_save_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_('All Tartube data has been saved'),
'info',
'ok',
)
def on_menu_save_db(self, action, par):
"""Called from a callback in self.do_startup().
Save the Tartube database.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.save_db()
# Show a dialogue window for confirmation (unless file load/save has
# been disabled, in which case a dialogue has already appeared)
if not self.disable_load_save_flag:
self.dialogue_manager_obj.show_msg_dialogue(
_('Database saved'),
'info',
'ok',
)
def on_menu_send_feedback(self, action, par):
"""Called from a callback in self.do_startup().
Opens the Tartube feedback website.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
utils.open_file(self, __main__.__website_bugs__)
def on_menu_show_hidden(self, action, par):
"""Called from a callback in self.do_startup().
Un-hides all hidden media.Folder objects (and their children).
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
for name in self.media_name_dict:
dbid = self.media_name_dict[name]
media_data_obj = self.media_reg_dict[dbid]
if isinstance(media_data_obj, media.Folder) \
and media_data_obj.hidden_flag:
self.mark_folder_hidden(media_data_obj, False)
def on_menu_show_install(self, action, par):
"""Called from a callback in self.do_startup().
On MS Windows (only), opens Tartube's installation folder.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# (This path assumes that the standard NSIS installation script was
# used to install Tartube)
utils.open_file(
self,
self.script_parent_dir + '\\..\\..\\..\\..\\..',
)
def on_menu_show_script(self, action, par):
"""Called from a callback in self.do_startup().
On MS Windows (only), opens Tartube's home folder.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
utils.open_file(self, self.script_parent_dir)
def on_menu_stop_soon(self, action, par):
"""Called from a callback in self.do_startup().
Stops the current download operation as soon as the current videos
have finished being checked/downloaded.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Sanity check
if not self.download_manager_obj:
return self.system_error(
191,
'Stop download operation soon request failed sanity check',
)
# Tell the download manager to continue downloading the current videos
# (if any), and then stop
self.download_manager_obj.stop_download_operation_soon()
def on_menu_system_preferences(self, action, par):
"""Called from a callback in self.do_startup().
Opens a preference window to edit system preferences.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
config.SystemPrefWin(self)
def on_menu_test(self, action, par):
"""Called from a callback in self.do_startup().
Add a set of media data objects for testing. This function can only be
called if the debugging flags are set.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Add media data objects for testing: videos, channels, playlists and/
# or folders
testing.add_test_media(self)
# Clicking the Test button more than once just adds illegal duplicate
# channels/playlists/folders (and non-illegal duplicate videos), so
# just disable the button and the menu item
self.main_win_obj.desensitise_test_widgets()
# Redraw the video catalogue, if a Video Index row is selected
if self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
def on_menu_test_code(self, action, par):
"""Called from a callback in self.do_startup().
Executes some arbitrary test code. This function can only be called if
the debugging flags are set.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
result = testing.run_test_code(self)
self.dialogue_manager_obj.show_msg_dialogue(
'Test code executed\n\nResult: ' + str(result),
'info',
'ok',
None, # Parent window is main window
)
def on_menu_test_ytdl(self, action, par):
"""Called from a callback in self.do_startup().
Start an info operation to test a youtube-dl command.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Prompt the user for what should be tested
dialogue_win = mainwin.TestCmdDialogue(self.main_win_obj)
response = dialogue_win.run()
# Retrieve user choices from the dialogue window...
url_string = dialogue_win.entry.get_text()
options_string = dialogue_win.textbuffer.get_text(
dialogue_win.textbuffer.get_start_iter(),
dialogue_win.textbuffer.get_end_iter(),
False,
)
# ...before destroying it
dialogue_win.destroy()
# If the user specified either (or both) a URL and youtube-dl options,
# then we can proceed
if response == Gtk.ResponseType.OK \
and (url_string != '' or options_string != ''):
# Start the info operation, which issues the youtube-dl command
# with the specified options
self.info_manager_start(
'test_ytdl',
None, # No media.Video object in this case
url_string, # Use the source, if specified
options_string, # Use download options, if specified
)
def on_menu_tidy_up(self, action, par):
"""Called from a callback in self.do_startup().
Start a tidy operation to tidy up Tartube's data directory.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Prompt the user to specify which actions should be applied to
# Tartube's data directory
dialogue_win = mainwin.TidyDialogue(self.main_win_obj)
response = dialogue_win.run()
if response == Gtk.ResponseType.OK:
# Retrieve user choices from the dialogue window
choices_dict = {
'media_data_obj': None,
'corrupt_flag': dialogue_win.checkbutton.get_active(),
'del_corrupt_flag': dialogue_win.checkbutton2.get_active(),
'exist_flag': dialogue_win.checkbutton3.get_active(),
'del_video_flag': dialogue_win.checkbutton4.get_active(),
'del_others_flag': dialogue_win.checkbutton5.get_active(),
'remove_no_url_flag': dialogue_win.checkbutton6.get_active(),
'remove_dupe_flag': dialogue_win.checkbutton7.get_active(),
'del_archive_flag': dialogue_win.checkbutton8.get_active(),
'move_thumb_flag': dialogue_win.checkbutton9.get_active(),
'del_thumb_flag': dialogue_win.checkbutton10.get_active(),
'convert_webp_flag': dialogue_win.checkbutton11.get_active(),
'move_data_flag': dialogue_win.checkbutton12.get_active(),
'del_descrip_flag': dialogue_win.checkbutton13.get_active(),
'del_json_flag': dialogue_win.checkbutton14.get_active(),
'del_xml_flag': dialogue_win.checkbutton15.get_active(),
}
# Now destroy the window
dialogue_win.destroy()
if response == Gtk.ResponseType.OK:
# If nothing was selected, then there is nothing to do
selected_flag = False
for key in choices_dict.keys():
if choices_dict[key]:
selected_flag = True
break
if not selected_flag:
return
# Prompt the user for confirmation, before deleting any files
if choices_dict['del_corrupt_flag'] \
or choices_dict['del_video_flag'] \
or choices_dict['del_archive_flag'] \
or choices_dict['del_thumb_flag'] \
or choices_dict['del_descrip_flag'] \
or choices_dict['del_json_flag'] \
or choices_dict['del_xml_flag']:
self.dialogue_manager_obj.show_msg_dialogue(
_(
'Files cannot be recovered, after being deleted. Are you' \
+ ' sure you want to continue?',
),
'question',
'yes-no',
None, # Parent window is main window
{
'yes': 'tidy_manager_start',
# Specified options
'data': choices_dict,
},
)
else:
# Start the tidy operation now
self.tidy_manager_start(choices_dict)
def on_menu_unmark_all(self, action, par):
"""Called from a callback in self.do_startup().
Unmarks all items in the Video Index.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.main_win_obj.video_index_reset_marker()
def on_menu_update_live(self, action, par):
"""Called from a callback in self.do_startup().
Forces the livestream operation to start. Ignored if any operation
(including an existing livestream operation) is running.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
# Because livestream operations run silently in the background, when
# the user goes to the trouble of clicking a menu item in the
# main window's menu, tell them why nothing is happening
msg = _('Cannot update existing livestreams because')
if (self.current_manager_obj and not self.download_manager_obj):
msg += ' ' + _('there is another operation running')
elif self.livestream_manager_obj:
msg += ' ' + _('they are currently being updated')
elif self.main_win_obj.config_win_list:
msg += ' ' + _('one or more configuration windows are open')
elif not self.media_reg_live_dict:
msg += ' ' + _('there are no livestreams to update')
else:
self.livestream_manager_start()
return
self.dialogue_manager_obj.show_msg_dialogue(msg, 'error', 'ok')
def on_menu_update_ytdl(self, action, par):
"""Called from a callback in self.do_startup().
Start an update operation to update the system's youtube-dl.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.update_manager_start('ytdl')
def on_menu_quit(self, action, par):
"""Called from a callback in self.do_startup().
Terminates the Tartube app.
Args:
action (Gio.SimpleAction): Object generated by Gio
par (None): Ignored
"""
self.stop()
# (Callback support functions)
def reject_container_name(self, name):
"""Called by self.on_menu_add_channel(), .on_menu_add_playlist()
and .on_menu_add_folder().
If the user specifies a name for a channel, playlist or folder that's
already in use by a channel, playlist or folder, tell them why they
can't use it.
Args:
name (str): The name specified by the user
"""
# Get the existing media data object with this name
dbid = self.media_name_dict[name]
media_data_obj = self.media_reg_dict[dbid]
media_type = media_data_obj.get_type()
if media_type == 'channel':
msg = _('There is already a channel with that name')
elif media_type == 'playlist':
msg = _('There is already a playlist with that name')
else:
msg = _('There is already a folder with that name')
self.dialogue_manager_obj.show_msg_dialogue(
msg + ' ' + _('(so please choose a different name)'),
'error',
'ok',
)
# Set accessors
def set_add_blocked_videos_flag(self, flag):
if not flag:
self.add_blocked_videos_flag = False
else:
self.add_blocked_videos_flag = True
def set_allow_ytdl_archive_flag(self, flag):
if not flag:
self.allow_ytdl_archive_flag = False
else:
self.allow_ytdl_archive_flag = True
def set_allow_ytdl_archive_mode(self, value):
self.allow_ytdl_archive_mode = value
def set_allow_ytdl_archive_path(self, value):
self.allow_ytdl_archive_path = value
def set_alt_bandwidth(self, value):
self.alt_bandwidth = value
def set_alt_bandwidth_apply_flag(self, flag):
if not flag:
self.alt_bandwidth_apply_flag = False
else:
self.alt_bandwidth_apply_flag = True
def set_alt_day_string(self, value):
self.alt_day_string = value
def set_alt_num_worker(self, value):
self.alt_num_worker = value
def set_alt_num_worker_apply_flag(self, flag):
if not flag:
self.alt_num_worker_apply_flag = False
else:
self.alt_num_worker_apply_flag = True
def set_alt_start_time(self, value):
self.alt_start_time = value
def set_alt_stop_time(self, value):
self.alt_stop_time = value
def set_apply_json_timeout_flag(self, flag):
if not flag:
self.apply_json_timeout_flag = False
else:
self.apply_json_timeout_flag = True
def add_auto_alarm_dict(self, video_obj):
self.media_reg_auto_alarm_dict[video_obj.dbid] = video_obj
def del_auto_alarm_dict(self, video_obj):
if video_obj.dbid in self.media_reg_auto_alarm_dict:
del self.media_reg_auto_alarm_dict[video_obj.dbid]
def set_auto_assign_errors_warnings_flag(self, flag):
if not flag:
self.auto_assign_errors_warnings_flag = False
else:
self.auto_assign_errors_warnings_flag = True
def set_auto_clone_options_flag(self, flag):
if not flag:
self.auto_clone_options_flag = False
else:
self.auto_clone_options_flag = True
def set_auto_delete_asap_flag(self, flag):
if not flag:
self.auto_delete_asap_flag = False
else:
self.auto_delete_asap_flag = True
def set_auto_delete_flag(self, flag):
if not flag:
self.auto_delete_flag = False
else:
self.auto_delete_flag = True
def set_auto_delete_days(self, days):
self.auto_delete_days = days
def set_auto_delete_options_flag(self, flag):
if not flag:
self.auto_delete_options_flag = False
else:
self.auto_delete_options_flag = True
def set_auto_delete_watched_flag(self, flag):
if not flag:
self.auto_delete_watched_flag = False
else:
self.auto_delete_watched_flag = True
def set_auto_expand_video_index_flag(self, flag):
if not flag:
self.auto_expand_video_index_flag = False
else:
self.auto_expand_video_index_flag = True
def add_auto_dl_start_dict(self, video_obj):
self.media_reg_auto_dl_start_dict[video_obj.dbid] = video_obj
def del_auto_dl_start_dict(self, video_obj):
if video_obj.dbid in self.media_reg_auto_dl_start_dict:
del self.media_reg_auto_dl_start_dict[video_obj.dbid]
def add_auto_dl_stop_dict(self, video_obj):
self.media_reg_auto_dl_stop_dict[video_obj.dbid] = video_obj
def del_auto_dl_stop_dict(self, video_obj):
if video_obj.dbid in self.media_reg_auto_dl_stop_dict:
del self.media_reg_auto_dl_stop_dict[video_obj.dbid]
def add_auto_notify_dict(self, video_obj):
self.media_reg_auto_notify_dict[video_obj.dbid] = video_obj
def del_auto_notify_dict(self, video_obj):
if video_obj.dbid in self.media_reg_auto_notify_dict:
del self.media_reg_auto_notify_dict[video_obj.dbid]
def add_auto_open_dict(self, video_obj):
self.media_reg_auto_open_dict[video_obj.dbid] = video_obj
def del_auto_open_dict(self, video_obj):
if video_obj.dbid in self.media_reg_auto_open_dict:
del self.media_reg_auto_open_dict[video_obj.dbid]
def set_auto_remove_flag(self, flag):
if not flag:
self.auto_remove_flag = False
else:
self.auto_remove_flag = True
def set_auto_remove_days(self, days):
self.auto_remove_days = days
def set_auto_switch_output_flag(self, flag):
if not flag:
self.auto_switch_output_flag = False
else:
self.auto_switch_output_flag = True
def set_autostop_size_flag(self, flag):
if not flag:
self.autostop_size_flag = False
else:
self.autostop_size_flag = True
def set_autostop_size_unit(self, value):
self.autostop_size_unit = value
def set_autostop_size_value(self, value):
self.autostop_size_value = value
def set_autostop_time_flag(self, flag):
if not flag:
self.autostop_time_flag = False
else:
self.autostop_time_flag = True
def set_autostop_time_unit(self, value):
self.autostop_time_unit = value
def set_autostop_time_value(self, value):
self.autostop_time_value = value
def set_autostop_videos_flag(self, flag):
if not flag:
self.autostop_videos_flag = False
else:
self.autostop_videos_flag = True
def set_autostop_videos_value(self, value):
self.autostop_videos_value = value
def set_avconv_path(self, path):
self.avconv_path = path
def set_bandwidth_apply_flag(self, flag):
"""Called by mainwin.MainWin.on_bandwidth_checkbutton_changed().
Applies or releases the bandwidth limit. If a download operation is in
progress, the new setting is applied to the next download job.
"""
if not flag:
self.bandwidth_apply_flag = False
else:
self.bandwidth_apply_flag = True
def set_bandwidth_default(self, value):
"""Called by mainwin.MainWin.on_bandwidth_spinbutton_changed().
Sets the new bandwidth limit. If a download operation is in progress,
the new value is applied to the next download job.
"""
if value < self.bandwidth_min or value > self.bandwidth_max:
return self.system_error(
192,
'Set bandwidth request failed sanity check',
)
self.bandwidth_default = value
def set_block_livestreams_flag(self, flag):
if not flag:
self.block_livestreams_flag = False
else:
self.block_livestreams_flag = True
def set_catalogue_draw_blocked_flag(self, flag):
if not flag:
self.catalogue_draw_blocked_flag = False
else:
self.catalogue_draw_blocked_flag = True
def set_catalogue_draw_downloaded_flag(self, flag):
if not flag:
self.catalogue_draw_downloaded_flag = False
else:
self.catalogue_draw_downloaded_flag = True
def set_catalogue_draw_frame_flag(self, flag):
if not flag:
self.catalogue_draw_frame_flag = False
else:
self.catalogue_draw_frame_flag = True
def set_catalogue_draw_icons_flag(self, flag):
if not flag:
self.catalogue_draw_icons_flag = False
else:
self.catalogue_draw_icons_flag = True
def set_catalogue_draw_undownloaded_flag(self, flag):
if not flag:
self.catalogue_draw_undownloaded_flag = False
else:
self.catalogue_draw_undownloaded_flag = True
def set_catalogue_filter_comment_flag(self, flag):
if not flag:
self.catalogue_filter_comment_flag = False
else:
self.catalogue_filter_comment_flag = True
def set_catalogue_filter_descrip_flag(self, flag):
if not flag:
self.catalogue_filter_descrip_flag = False
else:
self.catalogue_filter_descrip_flag = True
def set_catalogue_filter_name_flag(self, flag):
if not flag:
self.catalogue_filter_name_flag = False
else:
self.catalogue_filter_name_flag = True
def set_catalogue_page_size(self, size):
self.catalogue_page_size = size
def set_classic_custom_dl_flag(self, flag):
if not flag:
self.classic_custom_dl_flag = False
else:
self.classic_custom_dl_flag = True
def set_classic_dir_previous(self, directory):
self.classic_dir_previous = directory
def set_classic_duplicate_remove_flag(self, flag):
if not flag:
self.classic_duplicate_remove_flag = False
else:
self.classic_duplicate_remove_flag = True
def toggle_classic_pending_flag(self):
if not self.classic_pending_flag:
self.classic_pending_flag = True
else:
self.classic_pending_flag = False
def set_catalogue_clickable_container_flag(self, flag):
if not flag:
self.catalogue_clickable_container_flag = False
else:
self.catalogue_clickable_container_flag = True
# Re-draw the Video Catalogue to implement the new setting
if self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
def set_catalogue_show_nickname_flag(self, flag):
if not flag:
self.catalogue_show_nickname_flag = False
else:
self.catalogue_show_nickname_flag = True
# Re-draw the Video Catalogue to implement the new setting
if self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
)
def set_catalogue_sort_mode(self, mode):
self.catalogue_sort_mode = mode
def set_check_comment_fetch_flag(self, flag):
if not flag:
self.check_comment_fetch_flag = False
else:
self.check_comment_fetch_flag = True
def add_classic_dropzone_list(self, value):
self.classic_dropzone_list.append(value)
def del_classic_dropzone_list(self, value):
self.classic_dropzone_list.remove(value)
def set_classic_format_convert_flag(self, flag):
if not flag:
self.classic_format_convert_flag = False
else:
self.classic_format_convert_flag = True
def set_classic_format_selection(self, value):
self.classic_format_selection = value
def set_classic_livestream_flag(self, flag):
if not flag:
self.classic_livestream_flag = False
else:
self.classic_livestream_flag = True
def set_classic_resolution_selection(self, value):
self.classic_resolution_selection = value
def set_classic_ytdl_archive_flag(self, flag):
if not flag:
self.classic_ytdl_archive_flag = False
else:
self.classic_ytdl_archive_flag = True
def set_close_to_tray_flag(self, flag):
if not flag:
self.close_to_tray_flag = False
else:
self.close_to_tray_flag = True
def set_comment_show_formatted_flag(self, flag):
if not flag:
self.comment_show_formatted_flag = False
else:
self.comment_show_formatted_flag = True
def set_comment_show_text_time_flag(self, flag):
if not flag:
self.comment_show_text_time_flag = False
else:
self.comment_show_text_time_flag = True
def set_comment_store_flag(self, flag):
if not flag:
self.comment_store_flag = False
else:
self.comment_store_flag = True
def set_complex_index_flag(self, flag):
if not flag:
self.complex_index_flag = False
else:
self.complex_index_flag = True
def set_custom_bg(self, key, red, green, blue, alpha):
self.custom_bg_table[key] = [ red, green, blue, alpha ]
# Update the main window IV
self.main_win_obj.setup_bg_colour(key)
def reset_custom_bg(self, key):
self.custom_bg_table[key] = self.default_bg_table[key]
# Update the main window IV
self.main_win_obj.setup_bg_colour(key)
def set_custom_invidious_mirror(self, value):
self.custom_invidious_mirror = value
# The Video Catalogue must be redrawn to reset labels (but not when
# SimpleCatalogueItem are visible)
if self.catalogue_mode_type != 'simple' \
and self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_current_page,
)
def reset_custom_invidious_mirror(self):
self.custom_invidious_mirror = self.default_invidious_mirror
# The Video Catalogue must be redrawn to reset labels (but not when
# SimpleCatalogueItems are visible)
if self.catalogue_mode_type != 'simple' \
and self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_current_page,
)
def set_custom_locale(self, value):
self.custom_locale = value
self.update_locale_flag = True
def set_custom_sblock_mirror(self, value):
self.custom_sblock_mirror = value
def reset_custom_sblock_mirror(self):
self.custom_sblock_mirror = self.default_sblock_mirror
def set_data_dir(self, path):
"""Called by mainwin.MountDriveDialogue.on_button_clicked() and
wizwin.SetupWizWin.apply_changes() only; everything else should call
self.switch_db().
The call to this function resets the value of self.data_dir without
actually loading the database.
"""
self.data_dir = path
def reset_data_dir(self):
"""Called by mainwin.MountDriveDialogue.on_button_clicked() only;
everything else should call self.switch_db().
The call to this function resets the value of self.data_dir without
actually loading the database.
"""
self.data_dir = self.default_data_dir
def set_data_dir_add_from_list_flag(self, flag):
if not flag:
self.data_dir_add_from_list_flag = False
else:
self.data_dir_add_from_list_flag = True
def set_data_dir_alt_list(self, dir_list):
self.data_dir_alt_list = dir_list.copy()
def set_data_dir_use_first_flag(self, flag):
if not flag:
self.data_dir_use_first_flag = False
else:
self.data_dir_use_first_flag = True
def set_data_dir_use_list_flag(self, flag):
if not flag:
self.data_dir_use_list_flag = False
else:
self.data_dir_use_list_flag = True
def set_db_backup_mode(self, value):
self.db_backup_mode = value
def set_delete_container_files_flag(self, flag):
if not flag:
self.delete_container_files_flag = False
else:
self.delete_container_files_flag = True
def set_delete_on_shutdown_flag(self, flag):
if not flag:
self.delete_on_shutdown_flag = False
else:
self.delete_on_shutdown_flag = True
def set_delete_video_files_flag(self, flag):
if not flag:
self.delete_video_files_flag = False
else:
self.delete_video_files_flag = True
def set_dialogue_copy_clipboard_flag(self, flag):
if not flag:
self.dialogue_copy_clipboard_flag = False
else:
self.dialogue_copy_clipboard_flag = True
def set_dialogue_disable_msg_flag(self, flag):
if not flag:
self.dialogue_disable_msg_flag = False
else:
self.dialogue_disable_msg_flag = True
def set_dialogue_keep_open_flag(self, flag):
if not flag:
self.dialogue_keep_open_flag = False
else:
self.dialogue_keep_open_flag = True
def set_dialogue_yt_remind_flag(self, flag):
if not flag:
self.dialogue_yt_remind_flag = False
else:
self.dialogue_yt_remind_flag = True
def set_disable_dl_all_flag(self, flag):
if not flag:
self.disable_dl_all_flag = False
self.main_win_obj.enable_dl_all_buttons()
else:
self.disable_dl_all_flag = True
self.main_win_obj.disable_dl_all_buttons()
def set_disk_space_stop_flag(self, flag):
if not flag:
self.disk_space_stop_flag = False
else:
self.disk_space_stop_flag = True
def set_disk_space_stop_limit(self, value):
self.disk_space_stop_limit = value
def set_disk_space_warn_flag(self, flag):
if not flag:
self.disk_space_warn_flag = False
else:
self.disk_space_warn_flag = True
def set_disk_space_warn_limit(self, value):
self.disk_space_warn_limit = value
def set_dl_comment_fetch_flag(self, flag):
if not flag:
self.dl_comment_fetch_flag = False
else:
self.dl_comment_fetch_flag = True
def set_dl_proxy_list(self, proxy_list):
self.dl_proxy_list = proxy_list.copy()
def set_drag_thumb_path_flag(self, flag):
if not flag:
self.drag_thumb_path_flag = False
else:
self.drag_thumb_path_flag = True
def set_drag_video_name_flag(self, flag):
if not flag:
self.drag_video_name_flag = False
else:
self.drag_video_name_flag = True
def set_drag_video_path_flag(self, flag):
if not flag:
self.drag_video_path_flag = False
else:
self.drag_video_path_flag = True
def set_drag_video_source_flag(self, flag):
if not flag:
self.drag_video_source_flag = False
else:
self.drag_video_source_flag = True
def set_enable_livestreams_flag(self, flag):
if not flag:
self.enable_livestreams_flag = False
else:
self.enable_livestreams_flag = True
def set_export_csv_separator(self, value):
self.export_csv_separator = value
def set_ffmpeg_convert_webp_flag(self, flag):
if not flag:
self.ffmpeg_convert_webp_flag = False
else:
self.ffmpeg_convert_webp_flag = True
def set_ffmpeg_fail_flag(self, flag):
if not flag:
self.ffmpeg_fail_flag = False
else:
self.ffmpeg_fail_flag = True
def set_ffmpeg_options_obj(self, obj):
self.ffmpeg_options_obj = obj
def set_ffmpeg_path(self, path):
self.ffmpeg_path = path
def set_ffmpeg_simple_options_flag(self, flag):
if not flag:
self.ffmpeg_simple_options_flag = False
else:
self.ffmpeg_simple_options_flag = True
def set_fixed_recent_folder_days(self, value):
self.fixed_recent_folder_days = value
def set_full_expand_video_index_flag(self, flag):
if not flag:
self.full_expand_video_index_flag = False
else:
self.full_expand_video_index_flag = True
def set_graph_values(self, combo_type, value):
if combo_type == 'data_type':
self.graph_data_type = value
elif combo_type == 'plot_type':
self.graph_plot_type = value
elif combo_type == 'time_period':
self.graph_time_period_secs = value
elif combo_type == 'time_unit':
self.graph_time_unit_secs = value
elif combo_type == 'ink_colour':
self.graph_ink_colour = value
def set_ignore_child_process_exit_flag(self, flag):
if not flag:
self.ignore_child_process_exit_flag = False
else:
self.ignore_child_process_exit_flag = True
def set_ignore_custom_msg_list(self, custom_list):
self.ignore_custom_msg_list = custom_list.copy()
def set_ignore_custom_regex_flag(self, flag):
if not flag:
self.ignore_custom_regex_flag = False
else:
self.ignore_custom_regex_flag = True
def set_ignore_data_block_error_flag(self, flag):
if not flag:
self.ignore_data_block_error_flag = False
else:
self.ignore_data_block_error_flag = True
def set_ignore_http_404_error_flag(self, flag):
if not flag:
self.ignore_http_404_error_flag = False
else:
self.ignore_http_404_error_flag = True
def set_ignore_merge_warning_flag(self, flag):
if not flag:
self.ignore_merge_warning_flag = False
else:
self.ignore_merge_warning_flag = True
def set_ignore_missing_format_error_flag(self, flag):
if not flag:
self.ignore_missing_format_error_flag = False
else:
self.ignore_missing_format_error_flag = True
def set_ignore_no_annotations_flag(self, flag):
if not flag:
self.ignore_no_annotations_flag = False
else:
self.ignore_no_annotations_flag = True
def set_ignore_no_descrip_flag(self, flag):
if not flag:
self.ignore_no_descrip_flag = False
else:
self.ignore_no_descrip_flag = True
def set_ignore_no_subtitles_flag(self, flag):
if not flag:
self.ignore_no_subtitles_flag = False
else:
self.ignore_no_subtitles_flag = True
def set_ignore_page_given_flag(self, flag):
if not flag:
self.ignore_page_given_flag = False
else:
self.ignore_page_given_flag = True
def set_ignore_thumb_404_flag(self, flag):
if not flag:
self.ignore_thumb_404_flag = False
else:
self.ignore_thumb_404_flag = True
def set_ignore_yt_age_restrict_mode(self, value):
self.ignore_yt_age_restrict_mode = value
def set_ignore_yt_copyright_flag(self, flag):
if not flag:
self.ignore_yt_copyright_flag = False
else:
self.ignore_yt_copyright_flag = True
def set_ignore_yt_payment_flag(self, flag):
if not flag:
self.ignore_yt_payment_flag = False
else:
self.ignore_yt_payment_flag = True
def set_ignore_yt_uploader_deleted_flag(self, flag):
if not flag:
self.ignore_yt_uploader_deleted_flag = False
else:
self.ignore_yt_uploader_deleted_flag = True
def set_json_timeout_no_comments_time(self, value):
self.json_timeout_no_comments_time = value
def set_json_timeout_with_comments_time(self, value):
self.json_timeout_with_comments_time = value
def set_last_profile(self, value):
self.last_profile = value
def set_livestream_max_days(self, value):
self.livestream_max_days = value
def set_livestream_auto_alarm_flag(self, flag):
if not flag:
self.livestream_auto_alarm_flag = False
else:
self.livestream_auto_alarm_flag = True
def set_livestream_auto_dl_start_flag(self, flag):
if not flag:
self.livestream_auto_dl_start_flag = False
else:
self.livestream_auto_dl_start_flag = True
def set_livestream_auto_dl_stop_flag(self, flag):
if not flag:
self.livestream_auto_dl_stop_flag = False
else:
self.livestream_auto_dl_stop_flag = True
def set_livestream_auto_notify_flag(self, flag):
if not flag:
self.livestream_auto_notify_flag = False
else:
self.livestream_auto_notify_flag = True
def set_livestream_auto_open_flag(self, flag):
if not flag:
self.livestream_auto_open_flag = False
else:
self.livestream_auto_open_flag = True
def set_livestream_dl_mode(self, value):
self.livestream_dl_mode = value
def set_livestream_dl_timeout(self, value):
self.livestream_dl_timeout = value
def set_livestream_force_check_flag(self, flag):
if not flag:
self.livestream_force_check_flag = False
else:
self.livestream_force_check_flag = True
def set_livestream_replace_flag(self, flag):
if not flag:
self.livestream_replace_flag = False
else:
self.livestream_replace_flag = True
def set_livestream_simple_colour_flag(self, flag):
if not flag:
self.livestream_simple_colour_flag = False
else:
self.livestream_simple_colour_flag = True
def set_livestream_stop_is_final_flag(self, flag):
if not flag:
self.livestream_stop_is_final_flag = False
else:
self.livestream_stop_is_final_flag = True
def set_livestream_use_colour_flag(self, flag):
if not flag:
self.livestream_use_colour_flag = False
else:
self.livestream_use_colour_flag = True
def set_main_win_save_size_flag(self, flag):
if not flag:
self.main_win_save_size_flag = False
self.main_win_save_width = self.main_win_width
self.main_win_save_height = self.main_win_height
self.main_win_videos_slider_posn = self.paned_default_size
self.main_win_progress_slider_posn = self.paned_default_size
self.main_win_classic_slider_posn = self.paned_default_size
else:
self.main_win_save_size_flag = True
def set_main_win_save_slider_flag(self, flag):
if not flag:
self.main_win_save_slider_flag = False
self.main_win_videos_slider_posn = self.paned_default_size
self.main_win_progress_slider_posn = self.paned_default_size
self.main_win_classic_slider_posn = self.paned_default_size
else:
self.main_win_save_slider_flag = True
def set_main_win_slider_reset_flag(self, flag):
if not flag:
self.main_win_slider_reset_flag = False
else:
self.main_win_slider_reset_flag = True
def set_match_first_chars(self, num_chars):
self.match_first_chars = num_chars
def set_match_ignore_chars(self, num_chars):
self.match_ignore_chars = num_chars
def set_match_method(self, method):
self.match_method = method
def del_media_unavailable_dict(self, name):
del self.media_unavailable_dict[name]
def set_num_worker_apply_flag(self, flag):
"""Called by mainwin.MainWin.on_num_worker_checkbutton_changed().
Applies or releases the simultaneous download limit. If a download
operation is in progress, the new setting is applied to the next
download job.
"""
if not flag:
self.num_worker_apply_flag = False
else:
self.num_worker_apply_flag = True
def set_num_worker_default(self, value):
"""Called by mainwin.MainWin.on_num_worker_spinbutton_changed() and
.on_num_worker_checkbutton_changed().
Sets the new value for the number of simultaneous downloads allowed. If
a download operation is in progress, informs the download manager
object, so the number of download workers can be adjusted. Also
increases the number of pages in the Output tab, if necessary.
"""
if value < self.num_worker_min or value > self.num_worker_max:
return self.system_error(
193,
'Set simultaneous downloads request failed sanity check',
)
old_value = self.num_worker_default
self.num_worker_default = value
if old_value != value \
and self.download_manager_obj \
and not self.download_manager_obj.alt_limits_flag:
self.download_manager_obj.change_worker_count(value)
if value > self.main_win_obj.output_page_count:
self.main_win_obj.output_tab_setup_pages()
def set_num_worker_bypass_flag(self, flag):
if not flag:
self.num_worker_bypass_flag = False
else:
self.num_worker_bypass_flag = True
def set_open_temp_on_desktop_flag(self, flag):
if not flag:
self.open_temp_on_desktop_flag = False
else:
self.open_temp_on_desktop_flag = True
def set_output_size_apply_flag(self, flag):
if not flag:
self.output_size_apply_flag = False
else:
self.output_size_apply_flag = True
def set_output_size_default(self, value):
if value < self.output_size_min or value > self.output_size_max:
return self.system_error(
194,
'Set Output tab page size request failed sanity check',
)
old_value = self.output_size_default
self.output_size_default = value
if self.output_size_apply_flag:
self.main_win_obj.output_tab_update_page_size()
def set_open_in_tray_flag(self, flag):
if not flag:
self.open_in_tray_flag = False
else:
self.open_in_tray_flag = True
def set_operation_auto_restart_flag(self, flag):
if not flag:
self.operation_auto_restart_flag = False
else:
self.operation_auto_restart_flag = True
def set_operation_auto_restart_max(self, value):
self.operation_auto_restart_max = value
def set_operation_auto_restart_time(self, value):
self.operation_auto_restart_time = value
def set_operation_auto_update_flag(self, flag):
if not flag:
self.operation_auto_update_flag = False
else:
self.operation_auto_update_flag = True
def set_operation_check_limit(self, value):
self.operation_check_limit = value
def set_operation_convert_mode(self, mode):
if mode == 'disable' or mode == 'multi' or mode == 'channel' \
or mode == 'playlist':
self.operation_convert_mode = mode
def set_operation_dialogue_mode(self, mode):
if mode == 'default' or mode == 'desktop' or mode == 'dialogue':
self.operation_dialogue_mode = mode
def set_operation_download_limit(self, value):
self.operation_download_limit = value
def set_operation_error_show_flag(self, flag):
if not flag:
self.operation_error_show_flag = False
else:
self.operation_error_show_flag = True
def set_operation_halted_flag(self, flag):
if not flag:
self.operation_halted_flag = False
else:
self.operation_halted_flag = True
def set_operation_limit_flag(self, flag):
if not flag:
self.operation_limit_flag = False
else:
self.operation_limit_flag = True
def set_operation_save_flag(self, flag):
if not flag:
self.operation_save_flag = False
else:
self.operation_save_flag = True
def set_operation_sim_shortcut_flag(self, flag):
if not flag:
self.operation_sim_shortcut_flag = False
else:
self.operation_sim_shortcut_flag = True
def set_operation_warning_show_flag(self, flag):
if not flag:
self.operation_warning_show_flag = False
else:
self.operation_warning_show_flag = True
def set_progress_list_hide_flag(self, flag):
if not flag:
self.progress_list_hide_flag = False
else:
self.progress_list_hide_flag = True
# If a download operation is in progress, hide any hideable rows
# immediately
if self.download_manager_obj:
self.main_win_obj.progress_list_check_hide_rows(True)
def set_refresh_moviepy_timeout(self, value):
self.refresh_moviepy_timeout = value
def set_refresh_output_verbose_flag(self, flag):
if not flag:
self.refresh_output_verbose_flag = False
else:
self.refresh_output_verbose_flag = True
def set_refresh_output_videos_flag(self, flag):
if not flag:
self.refresh_output_videos_flag = False
else:
self.refresh_output_videos_flag = True
def set_restore_posn_from_tray_flag(self, flag):
if not flag:
self.restore_posn_from_tray_flag = False
else:
self.restore_posn_from_tray_flag = True
def set_results_list_reverse_flag(self, flag):
if not flag:
self.results_list_reverse_flag = False
else:
self.results_list_reverse_flag = True
def set_sblock_fetch_flag(self, flag):
if not flag:
self.sblock_fetch_flag = False
else:
self.sblock_fetch_flag = True
def set_sblock_obfuscate_flag(self, flag):
if not flag:
self.sblock_obfuscate_flag = False
else:
self.sblock_obfuscate_flag = True
def set_sblock_re_extract_flag(self, flag):
if not flag:
self.sblock_re_extract_flag = False
else:
self.sblock_re_extract_flag = True
def set_sblock_replace_flag(self, flag):
if not flag:
self.sblock_replace_flag = False
else:
self.sblock_replace_flag = True
def add_scheduled_list(self, scheduled_obj):
self.scheduled_list.append(scheduled_obj)
def del_scheduled_list(self, data_list):
scheduled_obj = data_list[0]
edit_win = data_list[1]
if scheduled_obj in self.scheduled_list:
self.scheduled_list.remove(scheduled_obj)
if edit_win is not None:
edit_win.setup_scheduling_start_tab_update_treeview()
def move_scheduled_list(self, name, flag):
"""'flag' is False to move an item up the list, True to move it down
the list."""
for scheduled_obj in self.scheduled_list:
if scheduled_obj.name == name:
index = self.scheduled_list.index(scheduled_obj)
if not flag and index > 0:
self.scheduled_list.insert(
index - 1,
self.scheduled_list.pop(index)
)
elif flag and index < (len(self.scheduled_list) - 1):
self.scheduled_list.insert(
index + 1,
self.scheduled_list.pop(index)
)
break
def set_scheduled_livestream_flag(self, flag):
if not flag:
self.scheduled_livestream_flag = False
else:
self.scheduled_livestream_flag = True
def set_scheduled_livestream_extra_flag(self, flag):
if not flag:
self.scheduled_livestream_extra_flag = False
else:
self.scheduled_livestream_extra_flag = True
def set_scheduled_livestream_wait_mins(self, value):
self.scheduled_livestream_wait_mins = value
def set_simple_options_flag(self, flag):
if not flag:
self.simple_options_flag = False
else:
self.simple_options_flag = True
def set_show_classic_tab_on_startup_flag(self, flag):
if not flag:
self.show_classic_tab_on_startup_flag = False
else:
self.show_classic_tab_on_startup_flag = True
def set_show_custom_dl_button_flag(self, flag):
if not flag:
self.show_custom_dl_button_flag = False
else:
self.show_custom_dl_button_flag = True
def set_show_custom_icons_flag(self, flag):
if not flag:
self.show_custom_icons_flag = False
else:
self.show_custom_icons_flag = True
def set_show_delete_container_dialogue_flag(self, flag):
if not flag:
self.show_delete_container_dialogue_flag = False
else:
self.show_delete_container_dialogue_flag = True
def set_show_delete_video_dialogue_flag(self, flag):
if not flag:
self.show_delete_video_dialogue_flag = False
else:
self.show_delete_video_dialogue_flag = True
def set_show_free_space_flag(self, flag):
if not flag:
self.show_free_space_flag = False
else:
self.show_free_space_flag = True
def set_show_msys2_dialogue_flag(self, flag):
if not flag:
self.show_msys2_dialogue_flag = False
else:
self.show_msys2_dialogue_flag = True
def set_show_newbie_dialogue_flag(self, flag):
if not flag:
self.show_newbie_dialogue_flag = False
else:
self.show_newbie_dialogue_flag = True
def set_show_pretty_dates_flag(self, flag):
if not flag:
self.show_pretty_dates_flag = False
else:
self.show_pretty_dates_flag = True
# Redraw the Video Catalogue, but only if something was already drawn
# there (and keep the current page number)
if self.main_win_obj.video_index_current is not None:
self.main_win_obj.video_catalogue_redraw_all(
self.main_win_obj.video_index_current,
self.main_win_obj.catalogue_toolbar_current_page,
)
def set_show_marker_in_index_flag(self, flag):
if not flag:
self.show_marker_in_index_flag = False
else:
self.show_marker_in_index_flag = True
# Reset all markers in the Video Index
self.main_win_obj.video_index_reset_marker()
# Redraw the Video Index and Video Catalogue
self.main_win_obj.video_index_catalogue_reset()
def set_show_small_icons_in_index_flag(self, flag):
if not flag:
self.show_small_icons_in_index_flag = False
else:
self.show_small_icons_in_index_flag = True
# Redraw the Video Index and Video Catalogue
self.main_win_obj.video_index_catalogue_reset()
def set_show_status_icon_flag(self, flag):
"""Called by config.SystemPrefWin.on_show_status_icon_toggled().
Shows/hides the status icon in the system tray.
"""
if not flag:
self.show_status_icon_flag = False
if self.status_icon_obj:
self.status_icon_obj.hide_icon()
else:
self.show_status_icon_flag = True
if self.status_icon_obj:
self.status_icon_obj.show_icon()
def set_show_tooltips_flag(self, flag):
if not flag:
self.show_tooltips_flag = False
# (The True argument forces the Video Catalogue to be redrawn)
self.main_win_obj.disable_tooltips(True)
else:
self.show_tooltips_flag = True
self.main_win_obj.enable_tooltips(True)
def set_show_tooltips_extra_flag(self, flag):
if not flag:
self.show_tooltips_extra_flag = False
else:
self.show_tooltips_extra_flag = True
def set_slice_video_cleanup_flag(self, flag):
if not flag:
self.slice_video_cleanup_flag = False
else:
self.slice_video_cleanup_flag = True
def set_sound_custom(self, value):
self.sound_custom = value
def set_split_video_add_db_flag(self, flag):
if not flag:
self.split_video_add_db_flag = False
else:
self.split_video_add_db_flag = True
def set_split_video_auto_delete_flag(self, flag):
if not flag:
self.split_video_auto_delete_flag = False
else:
self.split_video_auto_delete_flag = True
def set_split_video_auto_open_flag(self, flag):
if not flag:
self.split_video_auto_open_flag = False
else:
self.split_video_auto_open_flag = True
def set_split_video_clips_dir_flag(self, flag):
if not flag:
self.split_video_clips_dir_flag = False
else:
self.split_video_clips_dir_flag = True
def set_split_video_copy_thumb_flag(self, flag):
if not flag:
self.split_video_copy_thumb_flag = False
else:
self.split_video_copy_thumb_flag = True
def set_split_video_custom_title(self, value):
self.split_video_custom_title = value
def set_split_video_name_mode(self, value):
self.split_video_name_mode = value
def set_split_video_subdir_flag(self, flag):
if not flag:
self.split_video_subdir_flag = False
else:
self.split_video_subdir_flag = True
def set_store_playlist_id_flag(self, flag):
if not flag:
self.store_playlist_id_flag = False
else:
self.store_playlist_id_flag = True
def set_streamlink_path(self, value):
self.streamlink_path = value
def set_system_error_show_flag(self, flag):
if not flag:
self.system_error_show_flag = False
else:
self.system_error_show_flag = True
def set_system_msg_keep_totals_flag(self, flag):
if not flag:
self.system_msg_keep_totals_flag = False
else:
self.system_msg_keep_totals_flag = True
def set_system_msg_show_container_flag(self, flag):
if not flag:
self.system_msg_show_container_flag = False
else:
self.system_msg_show_container_flag = True
def set_system_msg_show_date_flag(self, flag):
if not flag:
self.system_msg_show_date_flag = False
else:
self.system_msg_show_date_flag = True
def set_system_msg_show_multi_line_flag(self, flag):
if not flag:
self.system_msg_show_multi_line_flag = False
else:
self.system_msg_show_multi_line_flag = True
def set_system_msg_show_video_flag(self, flag):
if not flag:
self.system_msg_show_video_flag = False
else:
self.system_msg_show_video_flag = True
def set_system_warning_show_flag(self, flag):
if not flag:
self.system_warning_show_flag = False
else:
self.system_warning_show_flag = True
def set_temp_slice_list(self, slice_list):
self.temp_slice_list = slice_list
def reset_temp_slice_list(self):
self.temp_slice_list = []
def set_temp_stamp_list(self, stamp_list):
self.temp_stamp_list = stamp_list
def reset_temp_stamp_list(self):
self.temp_stamp_list = []
def set_thumb_size_custom(self, value):
self.thumb_size_custom = value
def set_toolbar_hide_flag(self, flag):
if not flag:
self.toolbar_hide_flag = False
else:
self.toolbar_hide_flag = True
def set_toolbar_squeeze_flag(self, flag):
if not flag:
self.toolbar_squeeze_flag = False
else:
self.toolbar_squeeze_flag = True
if self.main_win_obj and self.main_win_obj.main_toolbar \
and not self.toolbar_hide_flag:
self.main_win_obj.redraw_main_toolbar()
def set_track_missing_time_days(self, value):
self.track_missing_time_days = value
def set_track_missing_time_flag(self, flag):
if not flag:
self.track_missing_time_flag = False
else:
self.track_missing_time_flag = True
def set_track_missing_videos_flag(self, flag):
if not flag:
self.track_missing_videos_flag = False
else:
self.track_missing_videos_flag = True
def set_url_change_confirm_flag(self, flag):
if not flag:
self.url_change_confirm_flag = False
else:
self.url_change_confirm_flag = True
def set_url_change_regex_flag(self, flag):
if not flag:
self.url_change_regex_flag = False
else:
self.url_change_regex_flag = True
def set_use_module_moviepy_flag(self, flag):
if not flag:
self.use_module_moviepy_flag = False
else:
self.use_module_moviepy_flag = True
def set_video_res_apply_flag(self, flag):
"""Called by mainwin.MainWin.on_video_res_checkbutton_changed().
Applies or releases the video resolution limit. If a download operation
is in progress, the new setting is applied to the next download job.
"""
if not flag:
self.video_res_apply_flag = False
else:
self.video_res_apply_flag = True
def set_video_res_default(self, value):
"""Called by mainwin.MainWin.set_video_res_limit() and
.on_video_res_combobox_changed()().
Sets the new video resolution limit. If a download operation is in
progress, the new value is applied to the next download job.
Args:
value (str): The new video resolution limit (a key in
formats.VIDEO_RESOLUTION_DICT, e.g. '720p')
"""
if not value in formats.VIDEO_RESOLUTION_DICT:
return self.system_error(
195,
'Set video resolution request failed sanity check',
)
self.video_res_default = value
def set_video_timestamps_extract_descrip_flag(self, flag):
if not flag:
self.video_timestamps_extract_descrip_flag = False
else:
self.video_timestamps_extract_descrip_flag = True
def set_video_timestamps_extract_json_flag(self, flag):
if not flag:
self.video_timestamps_extract_json_flag = False
else:
self.video_timestamps_extract_json_flag = True
def set_video_timestamps_re_extract_flag(self, flag):
if not flag:
self.video_timestamps_re_extract_flag = False
else:
self.video_timestamps_re_extract_flag = True
def set_video_timestamps_replace_flag(self, flag):
if not flag:
self.video_timestamps_replace_flag = False
else:
self.video_timestamps_replace_flag = True
def set_ytdl_fork(self, value):
self.ytdl_fork = value
# Update main window menu items
self.main_win_obj.update_menu()
def set_ytdl_fork_no_dependency_flag(self, flag):
if not flag:
self.ytdl_fork_no_dependency_flag = False
else:
self.ytdl_fork_no_dependency_flag = True
def set_ytdl_output_ignore_json_flag(self, flag):
if not flag:
self.ytdl_output_ignore_json_flag = False
else:
self.ytdl_output_ignore_json_flag = True
def set_ytdl_output_ignore_progress_flag(self, flag):
if not flag:
self.ytdl_output_ignore_progress_flag = False
else:
self.ytdl_output_ignore_progress_flag = True
def set_ytdl_output_show_summary_flag(self, flag):
if not flag:
self.ytdl_output_show_summary_flag = False
else:
self.ytdl_output_show_summary_flag = True
def set_ytdl_output_start_empty_flag(self, flag):
if not flag:
self.ytdl_output_start_empty_flag = False
else:
self.ytdl_output_start_empty_flag = True
def set_ytdl_output_stderr_flag(self, flag):
if not flag:
self.ytdl_output_stderr_flag = False
else:
self.ytdl_output_stderr_flag = True
def set_ytdl_output_stdout_flag(self, flag):
if not flag:
self.ytdl_output_stdout_flag = False
else:
self.ytdl_output_stdout_flag = True
def set_ytdl_output_system_cmd_flag(self, flag):
if not flag:
self.ytdl_output_system_cmd_flag = False
else:
self.ytdl_output_system_cmd_flag = True
def set_ytdl_path(self, path):
self.ytdl_path = path
def set_ytdl_path_custom_flag(self, flag):
if not flag:
self.ytdl_path_custom_flag = False
else:
self.ytdl_path_custom_flag = True
def set_ytdl_update_current(self, string):
self.ytdl_update_current = string
def set_ytdl_write_ignore_json_flag(self, flag):
if not flag:
self.ytdl_write_ignore_json_flag = False
else:
self.ytdl_write_ignore_json_flag = True
def set_ytdl_write_ignore_progress_flag(self, flag):
if not flag:
self.ytdl_write_ignore_progress_flag = False
else:
self.ytdl_write_ignore_progress_flag = True
def set_ytdl_write_stderr_flag(self, flag):
if not flag:
self.ytdl_write_stderr_flag = False
else:
self.ytdl_write_stderr_flag = True
def set_ytdl_write_stdout_flag(self, flag):
if not flag:
self.ytdl_write_stdout_flag = False
else:
self.ytdl_write_stdout_flag = True
def set_ytdl_write_system_cmd_flag(self, flag):
if not flag:
self.ytdl_write_system_cmd_flag = False
else:
self.ytdl_write_system_cmd_flag = True
def set_ytdl_write_verbose_flag(self, flag):
if not flag:
self.ytdl_write_verbose_flag = False
else:
self.ytdl_write_verbose_flag = True
Reference in New Issue View Git Blame Copy Permalink