You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
556 lines
18 KiB
556 lines
18 KiB
#!/usr/bin/env python2
|
|
|
|
"""Youtubedlg module responsible for the main app window. """
|
|
|
|
import os.path
|
|
|
|
import wx
|
|
from wx.lib.pubsub import setuparg1
|
|
from wx.lib.pubsub import pub as Publisher
|
|
|
|
from wx.lib.mixins.listctrl import ListCtrlAutoWidthMixin
|
|
|
|
from .optionsframe import OptionsFrame
|
|
from .updthread import UpdateThread
|
|
from .dlthread import DownloadManager
|
|
|
|
from .utils import (
|
|
YOUTUBEDL_BIN,
|
|
get_config_path,
|
|
get_icon_file,
|
|
shutdown_sys,
|
|
get_time,
|
|
open_dir
|
|
)
|
|
from .info import (
|
|
__appname__
|
|
)
|
|
|
|
|
|
class MainFrame(wx.Frame):
|
|
|
|
"""Main window class.
|
|
|
|
This class is responsible for creating the main app window
|
|
and binding the events.
|
|
|
|
Attributes:
|
|
FRAME_SIZE (tuple): Frame size (width, height).
|
|
BUTTONS_SIZE (tuple): Buttons size (width, height).
|
|
BUTTONS_SPACE (int): Horizontal space between the buttons.
|
|
SIZE_20 (int): Constant size number.
|
|
SIZE_10 (int): Constant size number.
|
|
SIZE_5 (int): Constant size number.
|
|
|
|
Labels area (strings): Strings for the widgets labels.
|
|
|
|
STATUSLIST_COLUMNS (tuple): Tuple of tuples that contains informations
|
|
about the ListCtrl columns. First item is the column name. Second
|
|
item is the column position. Third item is the constant column
|
|
label. Fourth item is the column width. Last item is a boolean
|
|
flag if True the current column is resizable.
|
|
|
|
Args:
|
|
opt_manager (optionsmanager.OptionsManager): Object responsible for
|
|
handling the settings.
|
|
|
|
log_manager (logmanager.LogManager): Object responsible for handling
|
|
the log stuff.
|
|
|
|
parent (wx.Window): Frame parent.
|
|
|
|
"""
|
|
|
|
FRAME_SIZE = (700, 490)
|
|
BUTTONS_SIZE = (90, 30)
|
|
BUTTONS_SPACE = 80
|
|
SIZE_20 = 20
|
|
SIZE_10 = 10
|
|
SIZE_5 = 5
|
|
|
|
# Labels area
|
|
URLS_LABEL = "URLs"
|
|
DOWNLOAD_LABEL = "Download"
|
|
UPDATE_LABEL = "Update"
|
|
OPTIONS_LABEL = "Options"
|
|
ERROR_LABEL = "Error"
|
|
STOP_LABEL = "Stop"
|
|
INFO_LABEL = "Info"
|
|
WELCOME_MSG = "Welcome"
|
|
SUCC_REPORT_MSG = ("Successfully downloaded {0} url(s) in {1} "
|
|
"day(s) {2} hour(s) {3} minute(s) {4} second(s)")
|
|
DL_COMPLETED_MSG = "Download completed"
|
|
URL_REPORT_MSG = "Downloading {0} url(s)"
|
|
CLOSING_MSG = "Stopping downloads"
|
|
CLOSED_MSG = "Downloads stopped"
|
|
PROVIDE_URL_MSG = "You need to provide at least one url"
|
|
DOWNLOAD_STARTED = "Download started"
|
|
|
|
VIDEO_LABEL = "Video"
|
|
SIZE_LABEL = "Size"
|
|
PERCENT_LABEL = "Percent"
|
|
ETA_LABEL = "ETA"
|
|
SPEED_LABEL = "Speed"
|
|
STATUS_LABEL = "Status"
|
|
#################################
|
|
|
|
STATUSLIST_COLUMNS = (
|
|
('filename', 0, VIDEO_LABEL, 150, True),
|
|
('filesize', 1, SIZE_LABEL, 80, False),
|
|
('percent', 2, PERCENT_LABEL, 65, False),
|
|
('eta', 3, ETA_LABEL, 45, False),
|
|
('speed', 4, SPEED_LABEL, 90, False),
|
|
('status', 5, STATUS_LABEL, 160, False)
|
|
)
|
|
|
|
def __init__(self, opt_manager, log_manager, parent=None):
|
|
wx.Frame.__init__(self, parent, title=__appname__, size=self.FRAME_SIZE)
|
|
self.opt_manager = opt_manager
|
|
self.log_manager = log_manager
|
|
self.download_manager = None
|
|
self.update_thread = None
|
|
self.app_icon = get_icon_file()
|
|
|
|
if self.app_icon is not None:
|
|
self.app_icon = wx.Icon(self.app_icon, wx.BITMAP_TYPE_PNG)
|
|
self.SetIcon(self.app_icon)
|
|
|
|
# Create options frame
|
|
self._options_frame = OptionsFrame(self)
|
|
|
|
# Create components
|
|
self._panel = wx.Panel(self)
|
|
|
|
self._url_text = self._create_statictext(self.URLS_LABEL)
|
|
self._url_list = self._create_textctrl(wx.TE_MULTILINE | wx.TE_DONTWRAP, self._on_urllist_edit)
|
|
|
|
self._download_btn = self._create_button(self.DOWNLOAD_LABEL, self._on_download)
|
|
self._update_btn = self._create_button(self.UPDATE_LABEL, self._on_update)
|
|
self._options_btn = self._create_button(self.OPTIONS_LABEL, self._on_options)
|
|
|
|
self._status_list = ListCtrl(self.STATUSLIST_COLUMNS,
|
|
parent=self._panel,
|
|
style=wx.LC_REPORT | wx.LC_HRULES | wx.LC_VRULES)
|
|
|
|
self._status_bar = self._create_statictext(self.WELCOME_MSG)
|
|
|
|
# Bind extra events
|
|
self.Bind(wx.EVT_CLOSE, self._on_close)
|
|
|
|
self._set_sizers()
|
|
|
|
# Set threads wx.CallAfter handlers using subscribe
|
|
self._set_publisher(self._update_handler, 'update')
|
|
self._set_publisher(self._status_list_handler, 'dlworker')
|
|
self._set_publisher(self._download_manager_handler, 'dlmanager')
|
|
|
|
def _set_publisher(self, handler, topic):
|
|
"""Sets a handler for the given topic.
|
|
|
|
Args:
|
|
handler (function): Can be any function with one parameter
|
|
the message that the caller sends.
|
|
|
|
topic (string): Can be any string that identifies the caller.
|
|
You can bind multiple handlers on the same topic or
|
|
multiple topics on the same handler.
|
|
|
|
"""
|
|
Publisher.subscribe(handler, topic)
|
|
|
|
def _create_statictext(self, label):
|
|
statictext = wx.StaticText(self._panel, label=label)
|
|
return statictext
|
|
|
|
def _create_textctrl(self, style=None, event_handler=None):
|
|
if style is None:
|
|
textctrl = wx.TextCtrl(self._panel)
|
|
else:
|
|
textctrl = wx.TextCtrl(self._panel, style=style)
|
|
|
|
if event_handler is not None:
|
|
textctrl.Bind(wx.EVT_TEXT, event_handler)
|
|
|
|
return textctrl
|
|
|
|
def _create_button(self, label, event_handler=None):
|
|
btn = wx.Button(self._panel, label=label, size=self.BUTTONS_SIZE)
|
|
|
|
if event_handler is not None:
|
|
btn.Bind(wx.EVT_BUTTON, event_handler)
|
|
|
|
return btn
|
|
|
|
def _create_popup(self, text, title, style):
|
|
wx.MessageBox(text, title, style)
|
|
|
|
def _set_sizers(self):
|
|
"""Sets the sizers of the main window. """
|
|
hor_sizer = wx.BoxSizer(wx.HORIZONTAL)
|
|
vertical_sizer = wx.BoxSizer(wx.VERTICAL)
|
|
|
|
vertical_sizer.AddSpacer(self.SIZE_10)
|
|
|
|
vertical_sizer.Add(self._url_text)
|
|
vertical_sizer.Add(self._url_list, 1, wx.EXPAND)
|
|
|
|
vertical_sizer.AddSpacer(self.SIZE_10)
|
|
|
|
buttons_sizer = wx.BoxSizer(wx.HORIZONTAL)
|
|
buttons_sizer.Add(self._download_btn)
|
|
buttons_sizer.Add(self._update_btn, flag=wx.LEFT | wx.RIGHT, border=self.BUTTONS_SPACE)
|
|
buttons_sizer.Add(self._options_btn)
|
|
vertical_sizer.Add(buttons_sizer, flag=wx.ALIGN_CENTER_HORIZONTAL)
|
|
|
|
vertical_sizer.AddSpacer(self.SIZE_10)
|
|
vertical_sizer.Add(self._status_list, 2, wx.EXPAND)
|
|
|
|
vertical_sizer.AddSpacer(self.SIZE_5)
|
|
vertical_sizer.Add(self._status_bar)
|
|
vertical_sizer.AddSpacer(self.SIZE_5)
|
|
|
|
hor_sizer.Add(vertical_sizer, 1, wx.EXPAND | wx.LEFT | wx.RIGHT, border=self.SIZE_20)
|
|
|
|
self._panel.SetSizer(hor_sizer)
|
|
|
|
def _update_youtubedl(self):
|
|
"""Update youtube-dl binary to the latest version. """
|
|
self._update_btn.Disable()
|
|
self._download_btn.Disable()
|
|
self.update_thread = UpdateThread(self.opt_manager.options['youtubedl_path'])
|
|
|
|
def _status_bar_write(self, msg):
|
|
"""Display msg in the status bar. """
|
|
self._status_bar.SetLabel(msg)
|
|
|
|
def _reset_widgets(self):
|
|
"""Resets GUI widgets after update or download process. """
|
|
self._download_btn.SetLabel(self.DOWNLOAD_LABEL)
|
|
self._download_btn.Enable()
|
|
self._update_btn.Enable()
|
|
|
|
def _print_stats(self):
|
|
"""Display download stats in the status bar. """
|
|
suc_downloads = self.download_manager.successful
|
|
dtime = get_time(self.download_manager.time_it_took)
|
|
|
|
msg = self.SUCC_REPORT_MSG.format(suc_downloads,
|
|
dtime['days'],
|
|
dtime['hours'],
|
|
dtime['minutes'],
|
|
dtime['seconds'])
|
|
|
|
self._status_bar_write(msg)
|
|
|
|
def _after_download(self):
|
|
"""Run tasks after download process has been completed.
|
|
|
|
Note:
|
|
Here you can add any tasks you want to run after the
|
|
download process has been completed.
|
|
|
|
"""
|
|
if self.opt_manager.options['shutdown']:
|
|
self.opt_manager.save_to_file()
|
|
shutdown_sys(self.opt_manager.options['sudo_password'])
|
|
else:
|
|
self._create_popup(self.DL_COMPLETED_MSG, self.INFO_LABEL, wx.OK | wx.ICON_INFORMATION)
|
|
if self.opt_manager.options['open_dl_dir']:
|
|
open_dir(self.opt_manager.options['save_path'])
|
|
|
|
def _status_list_handler(self, msg):
|
|
"""dlthread.Worker thread handler.
|
|
|
|
Handles messages from the Worker thread.
|
|
|
|
Args:
|
|
See dlthread.Worker _talk_to_gui() method.
|
|
|
|
"""
|
|
data = msg.data
|
|
|
|
self._status_list.write(data)
|
|
|
|
# Report number of urls been downloaded
|
|
msg = self.URL_REPORT_MSG.format(self.download_manager.active())
|
|
self._status_bar_write(msg)
|
|
|
|
def _download_manager_handler(self, msg):
|
|
"""dlthread.DownloadManager thread handler.
|
|
|
|
Handles messages from the DownloadManager thread.
|
|
|
|
Args:
|
|
See dlthread.DownloadManager _talk_to_gui() method.
|
|
|
|
"""
|
|
data = msg.data
|
|
|
|
if data == 'finished':
|
|
self._print_stats()
|
|
self._reset_widgets()
|
|
self.download_manager = None
|
|
self._after_download()
|
|
elif data == 'closed':
|
|
self._status_bar_write(self.CLOSED_MSG)
|
|
self._reset_widgets()
|
|
self.download_manager = None
|
|
else:
|
|
self._status_bar_write(self.CLOSING_MSG)
|
|
|
|
def _update_handler(self, msg):
|
|
"""dlthread.UpdateThread thread handler.
|
|
|
|
Handles messages from the UpdateThread thread.
|
|
|
|
Args:
|
|
See updthread.UpdateThread _talk_to_gui() method.
|
|
|
|
"""
|
|
data = msg.data
|
|
|
|
if data == 'finish':
|
|
self._reset_widgets()
|
|
self.update_thread = None
|
|
else:
|
|
self._status_bar_write(data)
|
|
|
|
def _get_urls(self):
|
|
"""Returns urls list. """
|
|
return self._url_list.GetValue().split('\n')
|
|
|
|
def _start_download(self):
|
|
"""Handles pre-download tasks & starts the download process. """
|
|
self._status_list.clear()
|
|
self._status_list.load_urls(self._get_urls())
|
|
|
|
if self._status_list.is_empty():
|
|
self._create_popup(self.PROVIDE_URL_MSG,
|
|
self.ERROR_LABEL,
|
|
wx.OK | wx.ICON_EXCLAMATION)
|
|
else:
|
|
self.download_manager = DownloadManager(self._status_list.get_items(),
|
|
self.opt_manager,
|
|
self.log_manager)
|
|
|
|
self._status_bar_write(self.DOWNLOAD_STARTED)
|
|
self._download_btn.SetLabel(self.STOP_LABEL)
|
|
self._update_btn.Disable()
|
|
|
|
def _on_urllist_edit(self, event):
|
|
"""Event handler of the self._status_list widget.
|
|
|
|
This method is used to dynamically add urls on the download_manager
|
|
after the download process has started.
|
|
|
|
Args:
|
|
event (wx.Event): Event item.
|
|
|
|
"""
|
|
if self.download_manager is not None:
|
|
self._status_list.load_urls(self._get_urls(), self.download_manager.add_url)
|
|
|
|
def _on_download(self, event):
|
|
"""Event handler of the self._download_btn widget.
|
|
|
|
This method is used when download-stop button is pressed to
|
|
start or stop the download process.
|
|
|
|
Args:
|
|
event (wx.Event): Event item.
|
|
|
|
"""
|
|
if self.download_manager is None:
|
|
self._start_download()
|
|
else:
|
|
self.download_manager.stop_downloads()
|
|
|
|
def _on_update(self, event):
|
|
"""Event handler of the self._update_btn widget.
|
|
|
|
This method is used when update button is pressed to start
|
|
the update process.
|
|
|
|
Note:
|
|
Currently there is not way to stop the update process.
|
|
|
|
Args:
|
|
event (wx.Event): Event item.
|
|
|
|
"""
|
|
self._update_youtubedl()
|
|
|
|
def _on_options(self, event):
|
|
"""Event handler of the self._options_btn widget.
|
|
|
|
This method is used when options button is pressed to show
|
|
the optios window.
|
|
|
|
Args:
|
|
event (wx.Event): Event item.
|
|
|
|
"""
|
|
self._options_frame.load_all_options()
|
|
self._options_frame.Show()
|
|
|
|
def _on_close(self, event):
|
|
"""Event handler method for the wx.EVT_CLOSE event.
|
|
|
|
This method is used when the user tries to close the program.
|
|
It's used to run some tasks on the shutdown like save the options
|
|
and make sure the download & update process are not running.
|
|
|
|
Args:
|
|
event (wx.Event): Event item.
|
|
|
|
"""
|
|
if self.download_manager is not None:
|
|
self.download_manager.stop_downloads()
|
|
self.download_manager.join()
|
|
|
|
if self.update_thread is not None:
|
|
self.update_thread.join()
|
|
|
|
self.opt_manager.save_to_file()
|
|
self.Destroy()
|
|
|
|
|
|
class ListCtrl(wx.ListCtrl, ListCtrlAutoWidthMixin):
|
|
|
|
"""Custom ListCtrl widget.
|
|
|
|
Args:
|
|
columns (tuple): See MainFrame class STATUSLIST_COLUMNS attribute.
|
|
|
|
"""
|
|
|
|
def __init__(self, columns, *args, **kwargs):
|
|
wx.ListCtrl.__init__(self, *args, **kwargs)
|
|
ListCtrlAutoWidthMixin.__init__(self)
|
|
self.columns = columns
|
|
self._list_index = 0
|
|
self._url_list = set()
|
|
self._set_columns()
|
|
|
|
def write(self, data):
|
|
"""Write data on ListCtrl row-column.
|
|
|
|
Args:
|
|
data (dictionary): Dictionary that contains data to be
|
|
written on the ListCtrl. In order for this method to
|
|
write the given data there must be an 'index' key that
|
|
identifies the current row and a corresponding key for
|
|
each item of the self.columns.
|
|
|
|
Note:
|
|
Income data must contain all the columns keys else a KeyError will
|
|
be raised. Also there must be an 'index' key that identifies the
|
|
row to write the data. For a valid data dictionary see
|
|
downloaders.YoutubeDLDownloader self._data.
|
|
|
|
"""
|
|
for column in self.columns:
|
|
column_key = column[0]
|
|
self._write_data(data[column_key], data['index'], column[1])
|
|
|
|
def load_urls(self, url_list, func=None):
|
|
"""Load URLs from the url_list on the ListCtrl widget.
|
|
|
|
Args:
|
|
url_list (list): List of strings that contains the URLs to add.
|
|
func (function): Callback function. It's used to add the URLs
|
|
on the download_manager.
|
|
|
|
"""
|
|
for url in url_list:
|
|
url = url.replace(' ', '')
|
|
|
|
if url and not self.has_url(url):
|
|
self.add_url(url)
|
|
|
|
if func is not None:
|
|
# Custom hack to add url into download_manager
|
|
item = self._get_item(self._list_index - 1)
|
|
func(item)
|
|
|
|
def has_url(self, url):
|
|
"""Returns True if url is aleady in the ListCtrl
|
|
else returns False.
|
|
|
|
Args:
|
|
url (string): URL string.
|
|
|
|
"""
|
|
return url in self._url_list
|
|
|
|
def add_url(self, url):
|
|
"""Adds the given url in the ListCtrl.
|
|
|
|
Args:
|
|
url (string): URL string.
|
|
|
|
"""
|
|
self.InsertStringItem(self._list_index, url)
|
|
self._url_list.add(url)
|
|
self._list_index += 1
|
|
|
|
def clear(self):
|
|
"""Clear ListCtrl widget & reset self._list_index and
|
|
self._url_list.
|
|
|
|
"""
|
|
self.DeleteAllItems()
|
|
self._list_index = 0
|
|
self._url_list = set()
|
|
|
|
def is_empty(self):
|
|
"""Returns True if the list is empty else False. """
|
|
return self._list_index == 0
|
|
|
|
def get_items(self):
|
|
"""Returns a list of items in ListCtrl.
|
|
|
|
Returns:
|
|
List of dictionaries that contains the 'url' and the
|
|
'index' (row) for each item of the ListCtrl.
|
|
|
|
"""
|
|
items = []
|
|
|
|
for row in xrange(self._list_index):
|
|
item = self._get_item(row)
|
|
items.append(item)
|
|
|
|
return items
|
|
|
|
def _write_data(self, data, row, column):
|
|
"""Write data on row-column. """
|
|
if isinstance(data, basestring):
|
|
self.SetStringItem(row, column, data)
|
|
|
|
def _get_item(self, index):
|
|
"""Returns corresponding ListCtrl item for the given index.
|
|
|
|
Args:
|
|
index (int): Index that identifies the row of the item.
|
|
Index must be smaller than the current self._list_index.
|
|
|
|
Returns:
|
|
Dictionary that contains the URL string of the row and the
|
|
row number (index).
|
|
|
|
"""
|
|
item = self.GetItem(itemId=index, col=0)
|
|
data = dict(url=item.GetText(), index=index)
|
|
return data
|
|
|
|
def _set_columns(self):
|
|
"""Initializes ListCtrl columns.
|
|
See MainFrame STATUSLIST_COLUMNS attribute for more info.
|
|
|
|
"""
|
|
for column in self.columns:
|
|
self.InsertColumn(column[1], column[2], width=column[3])
|
|
if column[4]:
|
|
self.setResizeColumn(column[1])
|
|
|