# -*- coding: utf-8 -*- # # gPodder - A media aggregator and podcast client # Copyright (c) 2005-2018 The gPodder Team # # gPodder 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. # # gPodder 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 . # import time from gi.repository import GLib, Gtk, Pango import gpodder from gpodder import util from gpodder.gtkui.widgets import SpinningProgressIndicator _ = gpodder.gettext class ProgressIndicator(object): # Delayed time until window is shown (for short operations) DELAY = 500 # Time between GUI updates after window creation INTERVAL = 250 def __init__(self, title, subtitle=None, cancellable=False, parent=None, max_ticks=None): self.title = title self.subtitle = subtitle self.cancellable = True if cancellable else False self.cancel_callback = cancellable self.cancel_id = 0 self.cancelled = False self.next_update = time.time() + (self.DELAY / 1000) self.parent = parent self.dialog = None self.progressbar = None self.indicator = None self._initial_message = None self._initial_progress = None self._progress_set = False # use timeout_add, not util.idle_timeout_add, so it updates before Gtk+ redraws the dialog self.source_id = GLib.timeout_add(self.DELAY, self._create_progress) self.set_max_ticks(max_ticks) def set_max_ticks(self, max_ticks): self.max_ticks = max_ticks self.tick_counter = 0 if max_ticks is not None: self.on_message('0 / %d' % max_ticks) def _on_delete_event(self, window, event): if self.cancellable: self.dialog.response(Gtk.ResponseType.CANCEL) self.cancellable = False self.cancelled = True return True def _create_progress(self): self.dialog = Gtk.MessageDialog(self.parent, 0, 0, Gtk.ButtonsType.CANCEL, self.subtitle or self.title) self.dialog.set_modal(True) self.dialog.connect('delete-event', self._on_delete_event) if self.cancellable: def cancel_callback(dialog, response): self.cancellable = False self.cancelled = True self.dialog.set_deletable(False) self.dialog.set_response_sensitive(Gtk.ResponseType.CANCEL, False) if callable(self.cancel_callback): self.cancel_callback(dialog, response) self.cancel_id = self.dialog.connect('response', cancel_callback) self.dialog.set_title(self.title) self.dialog.set_deletable(self.cancellable) # Avoid selectable text (requires PyGTK >= 2.22) if hasattr(self.dialog, 'get_message_area'): for label in self.dialog.get_message_area(): if isinstance(label, Gtk.Label): label.set_selectable(False) self.dialog.set_response_sensitive(Gtk.ResponseType.CANCEL, self.cancellable) self.progressbar = Gtk.ProgressBar() self.progressbar.set_show_text(True) self.progressbar.set_ellipsize(Pango.EllipsizeMode.END) # If the window is shown after the first update, set the progress # info so that when the window appears, data is there already if self._initial_progress is not None: self.progressbar.set_fraction(self._initial_progress) if self._initial_message is not None: self.progressbar.set_text(self._initial_message) self.dialog.vbox.add(self.progressbar) self.indicator = SpinningProgressIndicator() self.dialog.set_image(self.indicator) self.dialog.show_all() self._update_gui() # previous self.source_id timeout is removed when this returns False # use timeout_add, not util.idle_timeout_add, so it updates before Gtk+ redraws the dialog self.source_id = GLib.timeout_add(self.INTERVAL, self._update_gui) return False def _update_gui(self): if self.indicator: self.indicator.step_animation() if not self._progress_set and self.progressbar: self.progressbar.pulse() self.next_update = time.time() + (self.INTERVAL / 1000) return True def on_message(self, message): if self.progressbar: self.progressbar.set_text(message) else: self._initial_message = message def on_progress(self, progress): self._progress_set = True if self.progressbar: self.progressbar.set_fraction(progress) else: self._initial_progress = progress def on_tick(self, final=False): if final: # Dialog is no longer cancellable self.cancellable = False if self.dialog is not None: self.dialog.set_response_sensitive(Gtk.ResponseType.CANCEL, False) self.dialog.set_deletable(False) elif 2 * (time.time() - (self.next_update - (self.DELAY / 1000))) > (self.DELAY / 1000): # Assume final operation will take as long as all ticks and open dialog if self.source_id: GLib.source_remove(self.source_id) self._create_progress() if self.max_ticks is not None and not final: self.tick_counter += 1 if time.time() >= self.next_update or (final and self.dialog): if isinstance(final, str): self.on_message(final) self.on_progress(1.0) elif self.max_ticks is not None: self.on_message('%d / %d' % (self.tick_counter, self.max_ticks)) self.on_progress(self.tick_counter / self.max_ticks) # Allow UI to redraw. util.idle_add(Gtk.main_quit) # self._create_progress() or self._update_gui() is called by a timer to update the dialog Gtk.main() if self.cancelled: return False return True def on_finished(self): if self.dialog is not None: if self.cancel_id: self.dialog.disconnect(self.cancel_id) self.dialog.destroy() if self.source_id: GLib.source_remove(self.source_id)